security

Read Firewall Configuration

Changed on

Retrieve the specified firewall configuration for a project. The deployed configVersion will be active

get/v1/security/firewall/config/{configVersion}

Request

  • Base URL: https://api.vercel.com
  • URL: https://api.vercel.com/v1/security/firewall/config/{configVersion}
  • Auth: HTTP bearer

Path parameters

configVersionstring required

The deployed configVersion for the firewall configuration

Query parameters

projectIdstring required
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

If the firewall configuration includes a custom managed ruleset, it will include a crs item that has the following values: sd: Scanner Detection ma: Multipart Attack lfi: Local File Inclusion Attack rfi: Remote File Inclusion Attack rce: Remote Execution Attack php: PHP Attack gen: Generic Attack xss: XSS Attack sqli: SQL Injection Attack sf: Session Fixation Attack java: Java Attack

botIdEnabledfalse | true
changesobject[] required
firewallEnabledfalse | true required
idstring required
ownerIdstring required
projectKeystring required
updatedAtstring required
versionnumber required

Changes

  • a7512f1c1a48Revision changes
    • breaking

      added subschema #1 subschema #2 to the / response property oneOf list for the response status

    • warning

      added the new response_code enum value to the ////// response property for the response status

    • warning

      added the new response_code enum value to the /////// response property for the response status

    • info

      removed subschema #1 subschema #2 from the / response property oneOf list for the response status

  • e31ea8d3c1e7Revision changes
    • breaking

      added subschema #1 subschema #2 to the / response property oneOf list for the response status

    • warning

      added the new traffic_source enum value to the ////// response property for the response status

    • warning

      added the new traffic_source enum value to the /////// response property for the response status

    • info

      removed subschema #1 subschema #2 from the / response property oneOf list for the response status