security

Read Firewall Actions by Project

Changed on

Retrieve firewall actions for a project Rule names are resolved against the project's current active firewall configuration and the team's active rulesets, so a rule that has since been renamed reports its new name and one that has been deleted reports null. System rules such as sys_dos_mitigation and ip_blocking have no configured name and always report null. Filters (ip, isActive, action, actionType, ruleKind, ruleId, hosts) are ANDed across params and ORed within a repeated param. They are applied to the policies before limit/cursor, so pages only count matching policies. A policy with no matching requests yields no action row, so a page can hold fewer than limit actions; only pagination.next signals the end. A cursor is only valid with the filters it was issued for.

get/v1/security/firewall/events

Request

  • Base URL: https://api.vercel.com
  • URL: https://api.vercel.com/v1/security/firewall/events
  • Auth: HTTP bearer

Query parameters

sort'startTime:desc' | 'startTime:asc'
limitnumber
cursorstring
projectIdstring required
startTimestampnumber
endTimestampnumber
hostsstring
ipstring[]
isActiveboolean
actionstring[]
actionTypestring[]
ruleKind'system' | 'custom'
ruleIdstring[]
teamIdstring
Example:team_1a2b3c4d5e6f7g8h9i0j1k2l

The Team identifier to perform the request on behalf of.

slugstring
Example:my-team-url-slug

The Team slug to perform the request on behalf of.

Response

Changes

    • warning

      for the query request parameter hosts, the maxLength was set to 10000

    • info

      added the new optional query request parameter action

    • info

      added the new optional query request parameter actionType

    • info

      added the new optional query request parameter cursor

    • info

      added the new optional query request parameter ip

    • info

      added the new optional query request parameter isActive

    • info

      added the new optional query request parameter limit

    • info

      added the new optional query request parameter ruleId

    • info

      added the new optional query request parameter ruleKind

    • info

      added the new optional query request parameter sort

    • info

      added the required property to the response with the status

    • info

      added the non-success response with the status