ScalixScalix Docs
Sign up

WAF API

Web application firewall API for Scalix Cloud to create, update, and delete WAF rules, review recent security events, and read WAF statistics.

REST API endpoints for WAF. 6 operations.

List recent WAF events

plaintext
GET /v1/waf/events

Returns the most recent web application firewall events (up to 100).

Auth: Bearer API key

Responses

StatusDescription
200Recent WAF events (up to 100)
401Missing or invalid credentials
403Token lacks the waf:read scope
500Internal error

operationId: listWafEvents

List WAF rules

plaintext
GET /v1/waf/rules

Returns all configured web application firewall rules.

Auth: Bearer API key

Responses

StatusDescription
200All WAF rules
401Missing or invalid credentials
403Token lacks the waf:read scope
500Internal error

operationId: listWafRules

Create a WAF rule

plaintext
POST /v1/waf/rules

Adds a new web application firewall rule and returns the created rule.

Auth: Bearer API key

Request body

application/json (required) — schema CreateRuleRequest.

Responses

StatusDescription
200Rule created
400Rule uses a pattern/action the WAF does not enforce
401Missing or invalid credentials
403Token lacks the waf:write scope
500Internal error

operationId: createWafRule

Delete a WAF rule

plaintext
DELETE /v1/waf/rules/{id}

Removes a web application firewall rule by id.

Auth: Bearer API key

Parameters

NameInTypeRequiredDescription
idpathstringYesRule id (UUID)

Responses

StatusDescription
200Rule deleted
401Missing or invalid credentials
403Token lacks the waf:write scope
404Rule not found
500Internal error

operationId: deleteWafRule

Update a WAF rule

plaintext
PUT /v1/waf/rules/{id}

Replaces the configuration of an existing web application firewall rule.

Auth: Bearer API key

Parameters

NameInTypeRequiredDescription
idpathstringYesRule id (UUID)

Request body

application/json (required) — schema CreateRuleRequest.

Responses

StatusDescription
200Rule updated
401Missing or invalid credentials
403Token lacks the waf:write scope
404Rule not found
500Internal error

operationId: updateWafRule

Get WAF statistics

plaintext
GET /v1/waf/stats

Returns combined web application firewall and DDoS-detector counters.

Auth: Bearer API key

Responses

StatusDescription
200Combined WAF and DDoS statistics
401Missing or invalid credentials
403Token lacks the waf:read scope
500Internal error

operationId: getWafStats