v13

OpenAPI 3.0.32026-07-31359869.4 MB
security

Read Firewall Configuration

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

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

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

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