A WAF stage is part of a pipeline. It allows you to protect your origin from malicious requests, enhancing security. You can choose to either block or log the threats that are identified, and set a paranoia level to determine the sensitivity of the threat detection engine. Note that including a WAF stage in your pipeline is optional.
List WAF stages
List all WAF stages, for a Scaleway Organization or Scaleway Project. By default, the WAF stages returned in the list are ordered by creation date in ascending order, though this can be modified via the order_by field.
path Parameters
pipeline_idPipeline ID to filter for. Only WAF stages from this pipeline will be returned.
query Parameters
order_bySort order of WAF stages in the response.
pagePage number to return, from the paginated results.
page_sizeNumber of WAF stages to return per page.
List WAF stages › Responses
Paginated list of WAF stages.
total_countCount of all WAF stages matching the requested criteria.
Create WAF stage
Create a new WAF stage. You must specify the mode and paranoia_level fields to customize the WAF.
path Parameters
pipeline_idPipeline ID the WAF stage belongs to. (UUID format)
Create WAF stage › Request Body
modeMode defining WAF behavior (disable/log_only/enable).
paranoia_levelSensitivity level (1,2,3,4) to use when classifying requests as malicious. With a high level, requests are more likely to be classed as malicious, and false positives are expected. With a lower level, requests are more likely to be classed as benign.
backend_stage_idID of the backend stage to forward requests to after the WAF stage. (UUID format)
Create WAF stage › Responses
idID of the WAF stage.
pipeline_idPipeline ID the WAF stage belongs to.
modeMode defining WAF behavior (disable/log_only/enable).
paranoia_levelSensitivity level (1,2,3,4) to use when classifying requests as malicious. With a high level, requests are more likely to be classed as malicious, and false positives are expected. With a lower level, requests are more likely to be classed as benign.
statusCurrent status of the stage.
created_atDate the WAF stage was created. (RFC 3339 format)
updated_atDate the WAF stage was last updated. (RFC 3339 format)
backend_stage_idID of the backend stage to forward requests to after the WAF stage. (UUID format)
Get WAF stage
Retrieve information about an existing WAF stage, specified by its waf_stage_id. Its full details are returned in the response object.
path Parameters
waf_stage_idID of the requested WAF stage.
Get WAF stage › Responses
idID of the WAF stage.
pipeline_idPipeline ID the WAF stage belongs to.
modeMode defining WAF behavior (disable/log_only/enable).
paranoia_levelSensitivity level (1,2,3,4) to use when classifying requests as malicious. With a high level, requests are more likely to be classed as malicious, and false positives are expected. With a lower level, requests are more likely to be classed as benign.
statusCurrent status of the stage.
created_atDate the WAF stage was created. (RFC 3339 format)
updated_atDate the WAF stage was last updated. (RFC 3339 format)
backend_stage_idID of the backend stage to forward requests to after the WAF stage. (UUID format)
Update WAF stage
Update the parameters of an existing WAF stage, specified by its waf_stage_id. Both mode and paranoia_level parameters can be updated.
path Parameters
waf_stage_idID of the WAF stage to update.
Update WAF stage › Request Body
modeMode defining WAF behavior (disable/log_only/enable).
paranoia_levelSensitivity level (1,2,3,4) to use when classifying requests as malicious. With a high level, requests are more likely to be classed as malicious, and false positives are expected. With a lower level, requests are more likely to be classed as benign.
backend_stage_idID of the backend stage to forward requests to after the WAF stage. (UUID format)
Update WAF stage › Responses
idID of the WAF stage.
pipeline_idPipeline ID the WAF stage belongs to.
modeMode defining WAF behavior (disable/log_only/enable).
paranoia_levelSensitivity level (1,2,3,4) to use when classifying requests as malicious. With a high level, requests are more likely to be classed as malicious, and false positives are expected. With a lower level, requests are more likely to be classed as benign.
statusCurrent status of the stage.
created_atDate the WAF stage was created. (RFC 3339 format)
updated_atDate the WAF stage was last updated. (RFC 3339 format)
backend_stage_idID of the backend stage to forward requests to after the WAF stage. (UUID format)