Scaleway logo
Commands

Documentation for `scw edge-services`

The CLI documentation pages are currently under construction

The content is up to date. We're making improvements to the site over the next few weeks for a better experience.

Edge Services API

Backend-stage management commands

Backend-stage management commands.

Create backend stage

Create a new backend stage. You must specify a type of backend (scaleway_s3, scaleway_lb, etc.) to configure the origin.

Usage:

TerminalCode
scw edge-services backend-stage create [arg=value ...]

Arguments:

NameDescriptionArgument Specifications
scaleway-s3.bucket-nameName of the Bucket
scaleway-s3.bucket-regionRegion of the Bucket
scaleway-s3.is-websiteDefines whether the bucket website feature is enabled
scaleway-lb.lbs.{index}.idID of the Load Balancer
scaleway-lb.lbs.{index}.zoneZone of the Load Balancer
scaleway-lb.lbs.{index}.frontend-idID of the frontend linked to the Load Balancer
scaleway-lb.lbs.{index}.is-sslDefines whether the Load Balancer's frontend handles SSL connections
scaleway-lb.lbs.{index}.domain-nameFully Qualified Domain Name (in the format subdomain.example.com) to use in HTTP requests sent towards your Load Balancer
scaleway-lb.lbs.{index}.has-websocketDefines whether to forward websocket requests to the load balancer
pipeline-idPipeline ID the Backend stage belongs toRequired
scaleway-serverless-container.region
scaleway-serverless-container.container-id
scaleway-serverless-function.region
scaleway-serverless-function.function-id

Delete backend stage

Delete an existing backend stage, specified by its backend_stage_id. Deleting a backend stage is permanent, and cannot be undone.

Usage:

TerminalCode
scw edge-services backend-stage delete <backend-stage-id ...> [arg=value ...]

Arguments:

NameDescriptionArgument Specifications
backend-stage-idID of the backend stage to deleteRequired

Get backend stage

Retrieve information about an existing backend stage, specified by its backend_stage_id. Its full details are returned in the response object.

Usage:

TerminalCode
scw edge-services backend-stage get <backend-stage-id ...> [arg=value ...]

Arguments:

NameDescriptionArgument Specifications
backend-stage-idID of the requested backend stageRequired

List backend stages

List all backend stages, for a Scaleway Organization or Scaleway Project. By default, the backend stages returned in the list are ordered by creation date in ascending order, though this can be modified via the order_by field.

Usage:

TerminalCode
scw edge-services backend-stage list [arg=value ...]

Arguments:

NameDescriptionArgument Specifications
order-bySort order of backend stages in the responseOne of: created_at_asc, created_at_desc
pipeline-idPipeline ID to filter for. Only backend stages from this pipeline will be returnedRequired
bucket-nameBucket name to filter for. Only backend stages from this Bucket will be returned
bucket-regionBucket region to filter for. Only backend stages with buckets in this region will be returned
lb-idLoad Balancer ID to filter for. Only backend stages with this Load Balancer will be returned

Update backend stage

Update the parameters of an existing backend stage, specified by its backend_stage_id.

Usage:

TerminalCode
scw edge-services backend-stage update <backend-stage-id ...> [arg=value ...]

Arguments:

NameDescriptionArgument Specifications
backend-stage-idID of the backend stage to updateRequired
scaleway-s3.bucket-nameName of the Bucket
scaleway-s3.bucket-regionRegion of the Bucket
scaleway-s3.is-websiteDefines whether the bucket website feature is enabled
scaleway-lb.lbs.{index}.idID of the Load Balancer
scaleway-lb.lbs.{index}.zoneZone of the Load Balancer
scaleway-lb.lbs.{index}.frontend-idID of the frontend linked to the Load Balancer
scaleway-lb.lbs.{index}.is-sslDefines whether the Load Balancer's frontend handles SSL connections
scaleway-lb.lbs.{index}.domain-nameFully Qualified Domain Name (in the format subdomain.example.com) to use in HTTP requests sent towards your Load Balancer
scaleway-lb.lbs.{index}.has-websocketDefines whether to forward websocket requests to the load balancer
scaleway-serverless-container.region
scaleway-serverless-container.container-id
scaleway-serverless-function.region
scaleway-serverless-function.function-id
pipeline-idPipeline ID the Backend stage belongs to

Cache-stage management commands

Cache-stage management commands.

Create cache stage

Create a new cache stage. You must specify the fallback_ttl field to customize the TTL of the cache.

Usage:

TerminalCode
scw edge-services cache-stage create [arg=value ...]

Arguments:

NameDescriptionArgument Specifications
fallback-ttlTime To Live (TTL) in seconds. Defines how long content is cachedDefault: 3600s
include-cookiesDefines whether responses to requests with cookies must be stored in the cache
backend-stage-idBackend stage ID the cache stage will be linked to
pipeline-idPipeline ID the Cache stage belongs toRequired
waf-stage-id
route-stage-id

Delete cache stage

Delete an existing cache stage, specified by its cache_stage_id. Deleting a cache stage is permanent, and cannot be undone.

Usage:

TerminalCode
scw edge-services cache-stage delete <cache-stage-id ...> [arg=value ...]

Arguments:

NameDescriptionArgument Specifications
cache-stage-idID of the cache stage to deleteRequired

Get cache stage

Retrieve information about an existing cache stage, specified by its cache_stage_id. Its full details, including Time To Live (TTL), are returned in the response object.

Usage:

TerminalCode
scw edge-services cache-stage get <cache-stage-id ...> [arg=value ...]

Arguments:

NameDescriptionArgument Specifications
cache-stage-idID of the requested cache stageRequired

List cache stages

List all cache stages, for a Scaleway Organization or Scaleway Project. By default, the cache stages returned in the list are ordered by creation date in ascending order, though this can be modified via the order_by field.

Usage:

TerminalCode
scw edge-services cache-stage list [arg=value ...]

Arguments:

NameDescriptionArgument Specifications
order-bySort order of cache stages in the responseOne of: created_at_asc, created_at_desc
pipeline-idPipeline ID to filter for. Only cache stages from this pipeline will be returnedRequired

Update cache stage

Update the parameters of an existing cache stage, specified by its cache_stage_id. Parameters which can be updated include the fallback_ttl, include_cookies and backend_stage_id.

Usage:

TerminalCode
scw edge-services cache-stage update <cache-stage-id ...> [arg=value ...]

Arguments:

NameDescriptionArgument Specifications
cache-stage-idID of the cache stage to updateRequired
fallback-ttlTime To Live (TTL) in seconds. Defines how long content is cached
include-cookiesDefines whether responses to requests with cookies must be stored in the cache
backend-stage-idBackend stage ID the cache stage will be linked to
waf-stage-id
route-stage-id

DNS-stage management commands

DNS-stage management commands.

Create DNS stage

Create a new DNS stage. You must specify the fqdns field to customize the domain endpoint, using a domain you already own.

Usage:

TerminalCode
scw edge-services dns-stage create [arg=value ...]

Arguments:

NameDescriptionArgument Specifications
fqdns.{index}Custom Fully Qualified Domain Name to be configured (only 1 FQDN can be setup for now)
tls-stage-idTLS stage ID the DNS stage will be linked to
cache-stage-idCache stage ID the DNS stage will be linked to
backend-stage-idBackend stage ID the DNS stage will be linked to
pipeline-idPipeline ID the DNS stage belongs toRequired
wildcard-domainSupport of wildcard (subdomains) for the given domain (a wildcard certificate is required to make it work)

Delete DNS stage

Delete an existing DNS stage, specified by its dns_stage_id. Deleting a DNS stage is permanent, and cannot be undone.

Usage:

TerminalCode
scw edge-services dns-stage delete <dns-stage-id ...> [arg=value ...]

Arguments:

NameDescriptionArgument Specifications
dns-stage-idID of the DNS stage to deleteRequired

Get DNS stage

Retrieve information about an existing DNS stage, specified by its dns_stage_id. Its full details, including FQDNs, are returned in the response object.

Usage:

TerminalCode
scw edge-services dns-stage get <dns-stage-id ...> [arg=value ...]

Arguments:

NameDescriptionArgument Specifications
dns-stage-idID of the requested DNS stageRequired

List DNS stages

List all DNS stages, for a Scaleway Organization or Scaleway Project. By default, the DNS stages returned in the list are ordered by creation date in ascending order, though this can be modified via the order_by field.

Usage:

TerminalCode
scw edge-services dns-stage list [arg=value ...]

Arguments:

NameDescriptionArgument Specifications
order-bySort order of DNS stages in the responseOne of: created_at_asc, created_at_desc
pipeline-idPipeline ID to filter for. Only DNS stages from this pipeline will be returnedRequired
fqdnFully Qualified Domain Name to filter for (in the format subdomain.example.com). Only DNS stages with this FQDN will be returned

Update DNS stage

Update the parameters of an existing DNS stage, specified by its dns_stage_id.

Usage:

TerminalCode
scw edge-services dns-stage update <dns-stage-id ...> [arg=value ...]

Arguments:

NameDescriptionArgument Specifications
dns-stage-idID of the DNS stage to updateRequired
fqdns.{index}Custom Fully Qualified Domain Name to be configured (only 1 FQDN can be setup for now)
tls-stage-idTLS stage ID the DNS stage will be linked to
cache-stage-idCache stage ID the DNS stage will be linked to
backend-stage-idBackend stage ID the DNS stage will be linked to
wildcard-domainSupport of wildcard (subdomains) for the given domain (a wildcard certificate is required to make it work)

Pipeline management commands

Pipeline management commands.

Create pipeline

Create a new pipeline. You must specify a dns_stage_id to form a stage-chain that goes all the way to the backend stage (origin), so the HTTP request will be processed according to the stages you created.

Usage:

TerminalCode
scw edge-services pipeline create [arg=value ...]

Arguments:

NameDescriptionArgument Specifications
project-idProject ID to use. If none is passed the default project ID will be used
nameName of the pipelineRequired
descriptionDescription of the pipelineRequired

Delete pipeline

Delete an existing pipeline, specified by its pipeline_id. Deleting a pipeline is permanent, and cannot be undone. Note that all stages linked to the pipeline are also deleted.

Usage:

TerminalCode
scw edge-services pipeline delete <pipeline-id ...> [arg=value ...]

Arguments:

NameDescriptionArgument Specifications
pipeline-idID of the pipeline to deleteRequired

Get pipeline

Retrieve information about an existing pipeline, specified by its pipeline_id. Its full details, including errors, are returned in the response object.

Usage:

TerminalCode
scw edge-services pipeline get <pipeline-id ...> [arg=value ...]

Arguments:

NameDescriptionArgument Specifications
pipeline-idID of the requested pipelineRequired

List pipelines

List all pipelines, for a Scaleway Organization or Scaleway Project. By default, the pipelines returned in the list are ordered by creation date in ascending order, though this can be modified via the order_by field.

Usage:

TerminalCode
scw edge-services pipeline list [arg=value ...]

Arguments:

NameDescriptionArgument Specifications
order-bySort order of pipelines in the responseOne of: created_at_asc, created_at_desc, name_asc, name_desc
namePipeline name to filter for. Only pipelines with this string within their name will be returned
project-idProject ID to filter for. Only pipelines from this Project will be returned
has-backend-stage-lbFilter on backend stage. Only pipelines with a Load Balancer origin will be returned
organization-idOrganization ID to filter for. Only pipelines from this Organization will be returned

List Head stage for your pipeline.

List Head stage for your pipeline.

Usage:

TerminalCode
scw edge-services pipeline list-head <pipeline-id ...> [arg=value ...]

Arguments:

NameDescriptionArgument Specifications
pipeline-idID of the pipeline to updateRequired

Configure a entry point to your pipeline. You must specify a head stage to form a stage-chain that goes all the way to the backend stage (origin), so the HTTP request will be processed according to the stages you created.

You must specify either a add_new_head_stage (to add a new head stage), remove_head_stage (to remove a head stage) or swap_head_stage (to replace a head stage).

Usage:

TerminalCode
scw edge-services pipeline set-head <pipeline-id ...> [arg=value ...]

Arguments:

NameDescriptionArgument Specifications
pipeline-idID of the pipeline to updateRequired
add-new-head-stage.new-stage-id
remove-head-stage.remove-stage-id
swap-head-stage.new-stage-id
swap-head-stage.current-stage-id

Update pipeline

Update the parameters of an existing pipeline, specified by its pipeline_id. Parameters which can be updated include the name, description and dns_stage_id.

Usage:

TerminalCode
scw edge-services pipeline update <pipeline-id ...> [arg=value ...]

Arguments:

NameDescriptionArgument Specifications
pipeline-idID of the pipeline to updateRequired
nameName of the pipeline
descriptionDescription of the pipeline

Plan management commands

Plan management commands.

Delete plan

Unsubscribe from the current Edge Services subscription plan for your Scaleway Project.

Usage:

TerminalCode
scw edge-services plan delete [arg=value ...]

Arguments:

NameDescriptionArgument Specifications
project-idProject ID to use. If none is passed the default project ID will be used

Get plan

Get the current Edge Services subscription plan for your Scaleway Project.

Usage:

TerminalCode
scw edge-services plan get [arg=value ...]

Arguments:

NameDescriptionArgument Specifications
project-idProject ID to use. If none is passed the default project ID will be used

List plans

List all available Edge Services subscription plans.

Usage:

TerminalCode
scw edge-services plan list

Select plan

Subscribe to the Edge Services subscription plan of your choice, for the given Scaleway Project.

Usage:

TerminalCode
scw edge-services plan select [arg=value ...]

Arguments:

NameDescriptionArgument Specifications
project-idProject ID to use. If none is passed the default project ID will be used
plan-nameOne of: unknown_name, starter, professional, advanced

Purge-request management commands

Purge-request management commands.

Create purge request

Create a new purge request. You must specify either the all field (to purge all content) or a list of assets (to define the precise assets to purge).

Usage:

TerminalCode
scw edge-services purge-request create [arg=value ...]

Arguments:

NameDescriptionArgument Specifications
pipeline-idPipeline ID in which the purge request will be createdRequired
assets.{index}List of asserts to purge
allDefines whether to purge all content

Get purge request

Retrieve information about a purge request, specified by its purge_request_id. Its full details, including status and target, are returned in the response object.

Usage:

TerminalCode
scw edge-services purge-request get <purge-request-id ...> [arg=value ...]

Arguments:

NameDescriptionArgument Specifications
purge-request-idID of the requested purge requestRequired

List purge requests

List all purge requests, for a Scaleway Organization or Scaleway Project. This enables you to retrieve a history of all previously-made purge requests. By default, the purge requests returned in the list are ordered by creation date in ascending order, though this can be modified via the order_by field.

Usage:

TerminalCode
scw edge-services purge-request list [arg=value ...]

Arguments:

NameDescriptionArgument Specifications
order-bySort order of purge requests in the responseOne of: created_at_asc, created_at_desc
project-idProject ID to filter for. Only purge requests from this Project will be returned
pipeline-idPipeline ID to filter for. Only purge requests from this pipeline will be returned
organization-idOrganization ID to filter for. Only purge requests from this Organization will be returned

Route-rules management commands

Route-rules management commands.

Add route rules

Add route rules to an existing route stage, specified by its route_stage_id.

Usage:

TerminalCode
scw edge-services route-rules add <route-stage-id ...> [arg=value ...]

Arguments:

NameDescriptionArgument Specifications
route-stage-idID of the route stage to updateRequired
route-rules.{index}.rule-http-match.method-filters.{index}HTTP methods to filter for. A request using any of these methods will be considered to match the rule. Possible values are get, post, put, patch, delete, head, options. All methods will match if none is providedOne of: unknown_method_filter, get, post, put, patch, delete, head, options
route-rules.{index}.rule-http-match.path-filter.path-filter-typeType of filter to match for the HTTP URL path. For now, all path filters must be written in regex and use the regex typeOne of: unknown_path_filter, regex
route-rules.{index}.rule-http-match.path-filter.valueValue to be matched for the HTTP URL path
route-rules.{index}.rule-http-match.host-filter.host-filter-typeOne of: unknown_host_filter, regex
route-rules.{index}.rule-http-match.host-filter.value
route-rules.{index}.backend-stage-idID of the backend stage that requests matching the rule should be forwarded to
route-rules.{index}.waf-stage-idID of the WAF stage that requests matching the rule should be forwarded to
after-positionAdd rules after the given position
before-positionAdd rules before the given position

Edit all route rules of a route stage

Edit all route rules of a route stage.

If backend-stage-id is provided, the editor will only show rule_http_match fields and the specified backend will be applied to all rules automatically. Otherwise, opens the editor with full rules including backend_stage_id for each rule.

Usage:

TerminalCode
scw edge-services route-rules edit <route-stage-id ...> [arg=value ...]

Arguments:

NameDescriptionArgument Specifications
route-stage-idID of the route stage to editRequired
backend-stage-idID of the backend stage to apply to all rules (simplifies editing when using a single backend)
modemarshaling used when editing dataDefault: yaml
One of: yaml, json

List route rules

List all route rules of an existing route stage, specified by its route_stage_id.

Usage:

TerminalCode
scw edge-services route-rules list [arg=value ...]

Arguments:

NameDescriptionArgument Specifications
route-stage-idRoute stage ID to filter for. Only route rules from this route stage will be returnedRequired

Set route rules

Set the rules of an existing route stage, specified by its route_stage_id.

Usage:

TerminalCode
scw edge-services route-rules set <route-stage-id ...> [arg=value ...]

Arguments:

NameDescriptionArgument Specifications
route-stage-idID of the route stage to updateRequired
route-rules.{index}.rule-http-match.method-filters.{index}HTTP methods to filter for. A request using any of these methods will be considered to match the rule. Possible values are get, post, put, patch, delete, head, options. All methods will match if none is providedOne of: unknown_method_filter, get, post, put, patch, delete, head, options
route-rules.{index}.rule-http-match.path-filter.path-filter-typeType of filter to match for the HTTP URL path. For now, all path filters must be written in regex and use the regex typeOne of: unknown_path_filter, regex
route-rules.{index}.rule-http-match.path-filter.valueValue to be matched for the HTTP URL path
route-rules.{index}.rule-http-match.host-filter.host-filter-typeOne of: unknown_host_filter, regex
route-rules.{index}.rule-http-match.host-filter.value
route-rules.{index}.backend-stage-idID of the backend stage that requests matching the rule should be forwarded to
route-rules.{index}.waf-stage-idID of the WAF stage that requests matching the rule should be forwarded to

Route-stage management commands

Route-stage management commands.

Create route stage

Create a new route stage. You must specify the waf_stage_id or backend_stage_id fields to customize the route.

Usage:

TerminalCode
scw edge-services route-stage create [arg=value ...]

Arguments:

NameDescriptionArgument Specifications
pipeline-idPipeline ID the route stage belongs toRequired
waf-stage-idID of the WAF stage HTTP requests should be forwarded to when no rules are matched
backend-stage-idID of the backend stage HTTP requests should be forwarded to when no rules are matched

Delete route stage

Delete an existing route stage, specified by its route_stage_id. Deleting a route stage is permanent, and cannot be undone.

Usage:

TerminalCode
scw edge-services route-stage delete <route-stage-id ...> [arg=value ...]

Arguments:

NameDescriptionArgument Specifications
route-stage-idID of the route stage to deleteRequired

Get route stage

Retrieve information about an existing route stage, specified by its route_stage_id. The summary of the route stage (without route rules) is returned in the response object.

Usage:

TerminalCode
scw edge-services route-stage get <route-stage-id ...> [arg=value ...]

Arguments:

NameDescriptionArgument Specifications
route-stage-idID of the requested route stageRequired

List route stages

List all route stages, for a given pipeline. By default, the route stages returned in the list are ordered by creation date in ascending order, though this can be modified via the order_by field.

Usage:

TerminalCode
scw edge-services route-stage list [arg=value ...]

Arguments:

NameDescriptionArgument Specifications
order-bySort order of route stages in the responseOne of: created_at_asc, created_at_desc
pipeline-idPipeline ID to filter for. Only route stages from this pipeline will be returnedRequired

Update route stage

Update the parameters of an existing route stage, specified by its route_stage_id.

Usage:

TerminalCode
scw edge-services route-stage update <route-stage-id ...> [arg=value ...]

Arguments:

NameDescriptionArgument Specifications
route-stage-idID of the route stage to updateRequired
waf-stage-idID of the WAF stage HTTP requests should be forwarded to when no rules are matched
backend-stage-idID of the backend stage HTTP requests should be forwarded to when no rules are matched

TLS-stage management commands

TLS-stage management commands.

Create TLS stage

Create a new TLS stage. You must specify either the secrets or managed_certificate fields to customize the SSL/TLS certificate of your endpoint. Choose secrets if you are using a pre-existing certificate held in Scaleway Secret Manager, or managed_certificate to let Scaleway generate and manage a Let's Encrypt certificate for your customized endpoint.

Usage:

TerminalCode
scw edge-services tls-stage create [arg=value ...]

Arguments:

NameDescriptionArgument Specifications
secrets.{index}.secret-idID of the Secret
secrets.{index}.regionRegion of the Secret
managed-certificateTrue when Scaleway generates and manages a Let's Encrypt certificate for the TLS stage/custom endpoint
cache-stage-idCache stage ID the TLS stage will be linked to
backend-stage-idBackend stage ID the TLS stage will be linked to
pipeline-idPipeline ID the TLS stage belongs toRequired
route-stage-id
waf-stage-id

Delete TLS stage

Delete an existing TLS stage, specified by its tls_stage_id. Deleting a TLS stage is permanent, and cannot be undone.

Usage:

TerminalCode
scw edge-services tls-stage delete <tls-stage-id ...> [arg=value ...]

Arguments:

NameDescriptionArgument Specifications
tls-stage-idID of the TLS stage to deleteRequired

Get TLS stage

Retrieve information about an existing TLS stage, specified by its tls_stage_id. Its full details, including secrets and certificate expiration date are returned in the response object.

Usage:

TerminalCode
scw edge-services tls-stage get <tls-stage-id ...> [arg=value ...]

Arguments:

NameDescriptionArgument Specifications
tls-stage-idID of the requested TLS stageRequired

List TLS stages

List all TLS stages, for a Scaleway Organization or Scaleway Project. By default, the TLS stages returned in the list are ordered by creation date in ascending order, though this can be modified via the order_by field.

Usage:

TerminalCode
scw edge-services tls-stage list [arg=value ...]

Arguments:

NameDescriptionArgument Specifications
order-bySort order of TLS stages in the responseOne of: created_at_asc, created_at_desc
pipeline-idPipeline ID to filter for. Only TLS stages from this pipeline will be returnedRequired
secret-idSecret ID to filter for. Only TLS stages with this Secret ID will be returned
secret-regionSecret region to filter for. Only TLS stages with a Secret in this region will be returned

Update TLS stage

Update the parameters of an existing TLS stage, specified by its tls_stage_id. Both tls_secrets_config and managed_certificate parameters can be updated.

Usage:

TerminalCode
scw edge-services tls-stage update <tls-stage-id ...> [arg=value ...]

Arguments:

NameDescriptionArgument Specifications
tls-stage-idID of the TLS stage to updateRequired
tls-secrets-config.tls-secrets.{index}.secret-idID of the Secret
tls-secrets-config.tls-secrets.{index}.regionRegion of the Secret
managed-certificateTrue when Scaleway generates and manages a Let's Encrypt certificate for the TLS stage/custom endpoint
cache-stage-idCache stage ID the TLS stage will be linked to
backend-stage-idBackend stage ID the TLS stage will be linked to
route-stage-id
waf-stage-id

WAF-stage management commands

WAF-stage management commands.

Create WAF stage

Create a new WAF stage. You must specify the mode and paranoia_level fields to customize the WAF.

Usage:

TerminalCode
scw edge-services waf-stage create [arg=value ...]

Arguments:

NameDescriptionArgument Specifications
pipeline-idPipeline ID the WAF stage belongs toRequired
modeMode defining WAF behavior (disable/log_only/enable)One of: unknown_mode, 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.
exclusion-rules.rules.{index}.rule-id
backend-stage-idID of the backend stage to forward requests to after the WAF stage

Delete WAF stage

Delete an existing WAF stage, specified by its waf_stage_id. Deleting a WAF stage is permanent, and cannot be undone.

Usage:

TerminalCode
scw edge-services waf-stage delete <waf-stage-id ...> [arg=value ...]

Arguments:

NameDescriptionArgument Specifications
waf-stage-idID of the WAF stage to deleteRequired

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.

Usage:

TerminalCode
scw edge-services waf-stage get <waf-stage-id ...> [arg=value ...]

Arguments:

NameDescriptionArgument Specifications
waf-stage-idID of the requested WAF stageRequired

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.

Usage:

TerminalCode
scw edge-services waf-stage list [arg=value ...]

Arguments:

NameDescriptionArgument Specifications
order-bySort order of WAF stages in the responseOne of: created_at_asc, created_at_desc
pipeline-idPipeline ID to filter for. Only WAF stages from this pipeline will be returnedRequired

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.

Usage:

TerminalCode
scw edge-services waf-stage update <waf-stage-id ...> [arg=value ...]

Arguments:

NameDescriptionArgument Specifications
waf-stage-idID of the WAF stage to updateRequired
modeMode defining WAF behavior (disable/log_only/enable)One of: unknown_mode, 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.
exclusion-rules.rules.{index}.rule-id
backend-stage-idID of the backend stage to forward requests to after the WAF stage