Version 2.2.4 · latest Download OpenAPI Markdown

API changes 2.1.5 → 2.2.4

Operations, query parameters, request body fields and resource fields are compared one by one; only differences are listed. Operations 336 → 426

Compare from another version:2.2.0 → 2.2.4 View 2.2.4 API reference ›
Added operations
90
Changed operations
25
Resource field changes
15
Removed operations
0

Added operations 90

Added
GET/api/v2/bans/source-countsCount bans per source typeProtection › Bans
Added
GET/api/v2/bot-settingsGet bot settingsProtection › Bot settings
Added
PUT/api/v2/bot-settingsUpdate bot settingsProtection › Bot settings
Added
GET/api/v2/bot-statsGet bot statsProtection › Bot stats
Added
POST/api/v2/cc-matches/replayReplay a CC matcher draftProtection › CC matchers
Added
GET/api/v2/intelGet high-risk IP library statusProtection › High-risk IP library
Added
GET/api/v2/intel-reportsList intelligence reportsProtection › Threat intelligence reports
Added
POST/api/v2/intel/allowWhitelist a high-risk IPProtection › High-risk IP library
Added
GET/api/v2/intel/ipsList high-risk IP library entriesProtection › High-risk IP library
Added
PUT/api/v2/intel/policyUpdate high-risk IP library policyProtection › High-risk IP library
Added
GET/api/v2/intel/suspectsList suspicious IP report statusProtection › High-risk IP library
Added
POST/api/v2/intel/suspectsReport suspicious IPsProtection › High-risk IP library
Added
GET/api/v2/intel/visitorsHigh-risk IPs that visited todayProtection › High-risk IP library
Added
GET/api/v2/ip-sites/{id}/healthIP site origin health statusIP product line › IP sites
Added
GET/api/v2/l2/revoke-impactLicense loss impact and fallback windowTiered origin › Tiered origin (L2)
Added
DELETE/api/v2/me/avatarRemove avatarUser accounts › Current user
Added
GET/api/v2/me/avatarGet avatarUser accounts › Current user
Added
PUT/api/v2/me/avatarUpload avatarUser accounts › Current user
Added
GET/api/v2/message-webhooksList alert webhooksMessages › Alert webhooks
Added
POST/api/v2/message-webhooksCreate alert webhookMessages › Alert webhooks
Added
POST/api/v2/message-webhooks/testTest unsaved alert webhookMessages › Alert webhooks
Added
DELETE/api/v2/message-webhooks/{id}Delete alert webhookMessages › Alert webhooks
Added
PUT/api/v2/message-webhooks/{id}Update alert webhookMessages › Alert webhooks
Added
POST/api/v2/message-webhooks/{id}/testTest saved alert webhookMessages › Alert webhooks
Added
GET/api/v2/protect-schemes/leakGet the data leak protection schemeProtection › Value-added protection schemes
Added
PUT/api/v2/protect-schemes/leakSave the data leak protection schemeProtection › Value-added protection schemes
Added
GET/api/v2/protect-schemes/replayGet the replay protection schemeProtection › Value-added protection schemes
Added
PUT/api/v2/protect-schemes/replaySave the replay protection schemeProtection › Value-added protection schemes
Added
GET/api/v2/protect-schemes/replay/suggestionsList suggested replay protection endpointsProtection › Value-added protection schemes
Added
GET/api/v2/protect-schemes/tamperGet the web tamper protection schemeProtection › Value-added protection schemes
Added
PUT/api/v2/protect-schemes/tamperSave the web tamper protection schemeProtection › Value-added protection schemes
Added
POST/api/v2/protect-schemes/{kind}/applyApply the scheme to sites in bulkProtection › Value-added protection schemes
Added
GET/api/v2/protect-schemes/{kind}/sitesList the sites that have this protection set upProtection › Value-added protection schemes
Added
POST/api/v2/protect-schemes/{kind}/sites/bulkReset or turn off this protection for many sitesProtection › Value-added protection schemes
Added
GET/api/v2/reports/access-log-export-quotaGet today's access log download quotaReports › Reports
Added
GET/api/v2/reports/checkupSite checkup overviewReports › Reports
Added
GET/api/v2/reports/checkup/historyCheckup score historyReports › Reports
Added
GET/api/v2/reports/checkup/ignoresCheckup ignoresReports › Reports
Added
POST/api/v2/reports/checkup/ignores/batchAdd or remove checkup ignores in bulkReports › Reports
Added
GET/api/v2/reports/checkup/issuesCheckup problems grouped by checkReports › Reports
Added
GET/api/v2/reports/checkup/issues/{key}/sitesSites affected by a checkup problemReports › Reports
Added
POST/api/v2/reports/checkup/recheckRun the checkup againReports › Reports
Added
GET/api/v2/reports/checkup/runs/activeThe checkup batch in progressReports › Reports
Added
GET/api/v2/reports/checkup/runs/{id}Checkup batch progressReports › Reports
Added
GET/api/v2/reports/checkup/settingsGet checkup settingsReports › Reports
Added
PUT/api/v2/reports/checkup/settingsSave checkup settingsReports › Reports
Added
GET/api/v2/reports/checkup/sites/{id}Site checkup reportReports › Reports
Added
PUT/api/v2/reports/checkup/sites/{id}/appOverride a site's detected applicationReports › Reports
Added
PUT/api/v2/reports/checkup/sites/{id}/ignoresSet a site's checkup ignoresReports › Reports
Added
GET/api/v2/reports/ip-seenFirst and last time a visitor IP was seenReports › Reports
Added
GET/api/v2/reports/nodes/realtime-batchNode real-time curves (several metrics in one call)Reports › Reports
Added
GET/api/v2/reports/nodes/summaryNode ranking tableReports › Reports
Added
GET/api/v2/reports/security/overviewSecurity overviewReports › Reports
Added
GET/api/v2/reports/security/screenSecurity big-screen aggregateReports › Reports
Added
GET/api/v2/reports/sites/realtime-batchSite real-time curves (several metrics in one call)Reports › Reports
Added
GET/api/v2/reports/waf-events/exportExport WAF events as CSVReports › Reports
Added
GET/api/v2/reports/waf-events/summarySummarize WAF eventsReports › Reports
Added
GET/api/v2/reports/waf-events/{event_id}Get a WAF eventReports › Reports
Added
POST/api/v2/reports/waf-events/{event_id}/allowAllow-list a WAF eventReports › Reports
Added
DELETE/api/v2/site-leak-guards/{site_id}Restore site data leak protection to the schemeProtection › Data leak protection
Added
GET/api/v2/site-leak-guards/{site_id}Get site data leak protection settingsProtection › Data leak protection
Added
PUT/api/v2/site-leak-guards/{site_id}Set site data leak protectionProtection › Data leak protection
Added
DELETE/api/v2/site-replay-guards/{site_id}Restore site replay protection to the schemeProtection › Replay protection
Added
GET/api/v2/site-replay-guards/{site_id}Get site replay protection settingsProtection › Replay protection
Added
PUT/api/v2/site-replay-guards/{site_id}Set site replay protectionProtection › Replay protection
Added
DELETE/api/v2/site-tamper-guards/{site_id}Restore site web tamper protection to the schemeProtection › Web tamper protection
Added
GET/api/v2/site-tamper-guards/{site_id}Get site web tamper protection settingsProtection › Web tamper protection
Added
PUT/api/v2/site-tamper-guards/{site_id}Set site web tamper protectionProtection › Web tamper protection
Added
GET/api/v2/site-tamper-guards/{site_id}/diffGet site web tamper protection diffProtection › Web tamper protection
Added
POST/api/v2/site-tamper-guards/{site_id}/rebaseUpdate site web tamper protection baselineProtection › Web tamper protection
Added
POST/api/v2/sites/checkup-fix-batchBatch one-click fix for a checkup problemSites › Sites
Added
GET/api/v2/sites/checkup-fix-batchesList recent checkup fix batchesSites › Sites
Added
POST/api/v2/sites/protect-recommend/applyBatch apply the recommended protection settingsSites › Sites
Added
POST/api/v2/sites/protect-recommend/previewPreview the impact of the recommended protection settingsSites › Sites
Added
POST/api/v2/sites/protect-recommend/undoUndo a batch of recommended protection settingsSites › Sites
Added
POST/api/v2/sites/select-idsGet all site IDs matching a filterSites › Sites
Added
POST/api/v2/sites/{id}/checkup-fixOne-click fix for a checkup problemSites › Sites
Added
PUT/api/v2/sites/{id}/site-typeSet the site typeSites › Sites
Added
GET/api/v2/sites/{id}/upload-scan/exceptionsList a site's upload scan exceptionsSites › Sites
Added
DELETE/api/v2/sites/{id}/upload-scan/false-positiveRevoke a site's upload scan false-positive markSites › Sites
Added
POST/api/v2/sites/{id}/upload-scan/false-positiveMark a site's upload scan hit as a false positiveSites › Sites
Added
GET/api/v2/sites/{id}/url-guard/activeList a site's URL protections in effectSites › Sites
Added
POST/api/v2/sites/{id}/url-guard/revokeManually revoke a site's URL protections in effectSites › Sites
Added
GET/api/v2/tamper-guard/pagesList protected pages of all sitesProtection › Web tamper protection page overview
Added
GET/api/v2/upload-scan-settingsGet upload scan settingsProtection › Upload scan settings
Added
PUT/api/v2/upload-scan-settingsUpdate upload scan settingsProtection › Upload scan settings
Added
GET/api/v2/upload-scan-statsGet upload scan statsProtection › Upload scan stats
Added
GET/api/v2/url-guard-settingsGet network-wide URL protection settingsProtection › Network-wide URL protection settings
Added
PUT/api/v2/url-guard-settingsUpdate network-wide URL protection settingsProtection › Network-wide URL protection settings
Added
GET/api/v2/url-guard/activeList URL protections in effectProtection › Network-wide URL protection

Changed operations 25

Changed
DELETE/api/v2/auth/totpDisable TOTPAuthentication › Authentication
  • Body shape: — → object
  • Removed Query parameter code
  • Added Body field code
Changed
GET/api/v2/bansList bansProtection › Bans
  • Added Query parameter created_from
  • Added Query parameter source_type
Changed
POST/api/v2/bansCreate banProtection › Bans
  • Added Query parameter tenant_id
Changed
GET/api/v2/bans/site-countsCount bans per siteProtection › Bans
  • Added Query parameter created_from
  • Added Query parameter source_type
Changed
POST/api/v2/cc-filtersCreate CC filterProtection › CC filters
  • Added Body field count_key
Changed
PUT/api/v2/cc-filters/{id}Update CC filterProtection › CC filters
  • Added Body field count_key
Changed
PUT/api/v2/meUpdate profileUser accounts › Current user
  • Added Body field nickname
Changed
POST/api/v2/message-channels/testTest delivery channelMessages › Delivery channels
  • Added Body field draft
Changed
POST/api/v2/packagesCreate packagePackages › Packages
  • Added Body field l2
  • Added Body field waf_enhanced
Changed
PUT/api/v2/packages/{id}Update packagePackages › Packages
  • Added Body field l2
  • Added Body field waf_enhanced
Changed
POST/api/v2/reports/access-log-exportsRequest an access log downloadReports › Reports
  • Added Query parameter block_reason
  • Added Query parameter cache_status_not
  • Added Query parameter group_id
  • Added Query parameter http_ver
  • Added Query parameter method
  • Added Query parameter q
  • Added Query parameter referer
  • Removed Query parameter site_id
  • Added Query parameter site_ids
  • Added Query parameter slow_ms
  • Added Query parameter status_class
  • Added Query parameter tenant_ids
  • Added Query parameter upid
Changed
GET/api/v2/reports/access-logsList access logsReports › Reports
  • Added Query parameter block_reason
  • Added Query parameter cache_status_not
  • Added Query parameter facets
  • Added Query parameter group_id
  • Added Query parameter http_ver
  • Added Query parameter method
  • Added Query parameter q
  • Added Query parameter referer
  • Removed Query parameter site_id
  • Added Query parameter site_ids
  • Added Query parameter slow_ms
  • Added Query parameter status_class
  • Added Query parameter tenant_ids
  • Added Query parameter total
  • Added Query parameter upid
Changed
GET/api/v2/reports/nodes/realtimeNode real-time curvesReports › Reports
  • Changed Query parameter metric(enum: ["nic_in_bps","nic_out_bps","cpu_pct","mem_pct","load1","disk_space_pct","disk_inode_pct","tcp_conn","nginx_active","nginx_reading","nginx_writing","nginx_waiting","log_dropped","tls_hs_reject","worker_drain_killed"] → ["nic_in_bps","nic_out_bps","cpu_pct","mem_pct","load1","disk_space_pct","disk_inode_pct","tcp_conn","nginx_active","nginx_reading","nginx_writing","nginx_waiting","log_dropped","tls_hs_reject","worker_drain_killed","shm_used_pct","shm_write_fail"])
Changed
GET/api/v2/reports/nodes/topNode rankingReports › Reports
  • Changed Query parameter metric(enum: ["nic_in_bps","nic_out_bps","cpu_pct","mem_pct","load1","disk_space_pct","disk_inode_pct","tcp_conn","nginx_active","nginx_reading","nginx_writing","nginx_waiting","log_dropped","tls_hs_reject","worker_drain_killed"] → ["nic_in_bps","nic_out_bps","cpu_pct","mem_pct","load1","disk_space_pct","disk_inode_pct","tcp_conn","nginx_active","nginx_reading","nginx_writing","nginx_waiting","log_dropped","tls_hs_reject","worker_drain_killed","shm_used_pct","shm_write_fail"])
Changed
GET/api/v2/reports/sites/geoVisitor location statisticsReports › Reports
  • Added Query parameter group_id
  • Removed Query parameter site_id
  • Added Query parameter site_ids
  • Added Query parameter tenant_ids
  • Added Query parameter upid
Changed
GET/api/v2/reports/sites/overviewSite traffic overviewReports › Reports
  • Added Query parameter compare
  • Added Query parameter group_id
  • Added Query parameter site_ids
  • Added Query parameter tenant_ids
  • Added Query parameter upid
Changed
GET/api/v2/reports/sites/realtimeSite real-time curvesReports › Reports
  • Added Query parameter group_id
  • Removed Query parameter site_id
  • Added Query parameter site_ids
  • Added Query parameter tenant_ids
  • Added Query parameter upid
Changed
GET/api/v2/reports/sites/topSite rankingReports › Reports
  • Changed Query parameter dim(required: true → false; enum: ["ip","prefix","url","referer","site","status","http_ver","scheme","cache_status","ctype"] → ["ip","prefix","url","referer","site","status","http_ver","scheme","cache_status","ctype","country","prov","isp","port","block_reason"])
  • Added Query parameter dims
  • Added Query parameter group_id
  • Added Query parameter limit
  • Removed Query parameter site_id
  • Added Query parameter site_ids
  • Added Query parameter tenant_ids
  • Added Query parameter upid
Changed
GET/api/v2/reports/streams/realtimeTCP/UDP forwarding real-time curvesReports › Reports
  • Changed Query parameter metric(enum: ["bandwidth","bandwidth_in","traffic","traffic_in"] → ["bandwidth","bandwidth_in","traffic","traffic_in","req","conn_peak"])
Changed
GET/api/v2/reports/usageUsage curvesReports › Reports
  • Added Query parameter group_id
  • Changed Query parameter interval(enum: ["auto","5m"] → ["auto","5m","1h"])
  • Changed Query parameter metric(enum: ["bandwidth","traffic","req","qps","req_hit_ratio","status_5xx_ratio"] → ["bandwidth","traffic","req","qps","req_hit_ratio","status_5xx_ratio","status_4xx_ratio","backend_bandwidth","backend_traffic","backend_resp_time","blocked"])
  • Removed Query parameter site_id
  • Added Query parameter site_ids
  • Added Query parameter tenant_ids
Changed
GET/api/v2/reports/waf-eventsList WAF eventsReports › Reports
  • Added Query parameter action
  • Added Query parameter country
  • Added Query parameter disposition
  • Added Query parameter end
  • Added Query parameter ja4
  • Added Query parameter node_id
  • Added Query parameter observe
  • Added Query parameter province
  • Added Query parameter start
  • Added Query parameter type
  • Added Query parameter url
Changed
GET/api/v2/sitesList sitesSites › Sites
  • Added Query parameter app
  • Added Query parameter group_ids
Changed
PATCH/api/v2/sites/{id}/l2Update site tiered originSites › Sites
  • Added Body field l2_pick
Changed
PUT/api/v2/user-packages/{id}Update purchased packagePackages › Purchased packages
  • Added Body field l2
  • Added Body field waf_enhanced
Changed
PUT/api/v2/waf-settingsUpdate WAF settingsProtection › WAF settings
  • Added Body field enhanced
  • Added Body field intel_share
  • Added Body field level
  • Added Body field observe_days
  • Added Body field rule_lib
  • Added Body field scanner
  • Added Body field semantic
  • Added Body field trunc_action

Resource field changes 15

Field
authAuthenticationAuthentication
  • Added Field recovery_codes
Field
bansBansProtection
  • Added Field filter_id
  • Added Field intel
  • Added Field intel_hit
  • Added Field items
  • Added Field rule_id
  • Added Field source_type
Field
cc-filtersCC filtersProtection
  • Added Field count_key
Field
cc-matchesCC matchersProtection
  • Added Field hits
  • Added Field ips
  • Added Field reason
  • Added Field sampled
  • Added Field site_id
  • Added Field sites
  • Added Field supported
  • Added Field top_ips
  • Added Field top_urls
  • Added Field total
  • Added Field window_hours
Field
ip-sitesIP sitesIP product line
  • Added Field checked_at
  • Added Field nodes
  • Added Field status
Field
l2Tiered origin (L2)Tiered origin
  • Added Field l2_pick
  • Added Field origin_l2_only
  • Added Field owner_id
  • Added Field owner_name
Field
meCurrent userUser accounts
  • Added Field avatar_ver
  • Added Field client_ip
  • Added Field delegated_session
  • Added Field nickname
  • Added Field size
  • Added Field totp_recovery_left
Field
message-channelsDelivery channelsMessages
  • Added Field draft
Field
packagesPackagesPackages
  • Added Field l2
  • Added Field waf_enhanced
Field
registrationsRegistrationsUser accounts
  • Added Field avatar_ver
  • Added Field client_ip
  • Added Field delegated_session
  • Added Field nickname
  • Added Field totp_recovery_left
Field
reportsReportsReports
  • Added Field advice
  • Added Field app
  • Added Field app_manual
  • Added Field app_version
  • Added Field approx
  • Added Field attack_types
  • Added Field attacked_sites
  • Added Field ban_hits
  • Added Field block
  • Added Field blocked_by_feature
  • Added Field body_trunc
  • Added Field bot_score
  • Added Field category
  • Added Field challenge
  • Added Field checked_at
  • Added Field checkup
  • Added Field compare
  • Changed Field countries(type: GeoCount[] → SecurityCountryCount[])
  • Added Field covered
  • Added Field critical
  • Added Field current_site_id
  • Added Field cves
  • Added Field dims
  • Added Field domain
  • Added Field done_site_ids
  • Added Field done_sites
  • Added Field exception
  • Added Field extra
  • Added Field facets
  • Added Field file_count
  • Added Field file_ctype
  • Added Field file_field
  • Added Field file_magic
  • Added Field file_name
  • Added Field file_sha256
  • Added Field file_size
  • Added Field findings
  • Added Field first_seen
  • Added Field first_seen_at
  • Added Field flows
  • Added Field frequency
  • Added Field geo_summary
  • Added Field handled_by_feature
  • Added Field headers
  • Added Field history
  • Added Field hit_layer
  • Added Field intel_hit
  • Changed Field items(type: NodeTopItem[] → CheckupHistoryPoint[])
  • Added Field ja4
  • Added Field keys
  • Changed Field kind(type: HostNotFoundKind → string; enum: ["site","pointed_here","not_pointed","typo","scanner","unknown"] → ["domain","ip"])
  • Added Field last_seen_at
  • Added Field level
  • Added Field limit
  • Added Field medium
  • Added Field metrics
  • Added Field name
  • Added Field node_city
  • Added Field node_ips
  • Added Field node_lat
  • Added Field node_lon
  • Added Field node_spots
  • Added Field node_unknown
  • Added Field notify_critical
  • Added Field observe
  • Added Field observe_rule
  • Added Field op
  • Added Field open_url
  • Added Field other
  • Added Field param
  • Added Field params
  • Added Field path
  • Changed Field points(type: SitesOverviewPoint[] → SecurityPoint[])
  • Added Field prev_score
  • Added Field previous
  • Added Field probes
  • Added Field protocol
  • Added Field province
  • Added Field provinces
  • Added Field publish_seq
  • Added Field recent
  • Added Field referer_open_url
  • Added Field remaining
  • Added Field reset
  • Added Field result
  • Added Field rule
  • Added Field rules_ver
  • Added Field run
  • Added Field saved_bytes
  • Added Field scan_status
  • Added Field scan_steps
  • Added Field score
  • Added Field severity
  • Added Field site_deleted
  • Added Field site_ids
  • Added Field site_name
  • Added Field snippet
  • Added Field source_ips
  • Added Field stage
  • Added Field started_at
  • Added Field state
  • Added Field step
  • Added Field summary
  • Added Field target
  • Added Field top_rules
  • Added Field top_sites
  • Added Field total_sites
  • Added Field type
  • Added Field types
  • Added Field unavailable
  • Added Field unlimited
  • Added Field url
  • Added Field used
  • Added Field version
  • Added Field window_min
Field
sitesSitesSites
  • Added Field added_at
  • Added Field app
  • Added Field batch
  • Added Field default_pick
  • Added Field domain
  • Added Field gate_reasons
  • Added Field group_id
  • Added Field key
  • Added Field l2_pick
  • Added Field observe_days
  • Added Field origin
  • Added Field path
  • Added Field rec_ver
  • Added Field revoked
  • Added Field revoking_until
  • Added Field sha256
  • Added Field sig
  • Added Field site_id
  • Added Field skip
  • Added Field source
  • Added Field total
  • Added Field truncated
  • Added Field type
  • Added Field waf_gate
  • Added Field waf_gate_reason
Field
user-packagesPurchased packagesPackages
  • Added Field l2
  • Added Field waf_enhanced
Field
usersUsersUser accounts
  • Added Field avatar_ver
  • Added Field client_ip
  • Added Field delegated_session
  • Added Field nickname
  • Added Field totp_recovery_left
Field
waf-settingsWAF settingsProtection
  • Added Field enhanced
  • Added Field intel_share
  • Added Field level
  • Added Field observe_days
  • Added Field rule_lib
  • Added Field scanner
  • Added Field semantic
  • Added Field trunc_action