Schemas

List of rules to be checked against every HTTP request. The first matching rule will forward the request to its specified backend stage. If no rules are matched, the request is forwarded to the stage defined by waf_stage_id or backend_stage_id.

ID of the backend stage.

Pipeline ID the backend stage belongs to.

Current status of the stage.

Date the backend stage was created. (RFC 3339 format)

Date the backend stage was last updated. (RFC 3339 format)

Scaleway Object Storage origin bucket (S3) linked to the backend stage.

Scaleway Load Balancer origin linked to the backend stage.

Scaleway Serverless container origin linked to the backend stage.

Scaleway Serverless function origin linked to the backend stage.

ID of the cache stage.

Pipeline ID the cache stage belongs to.

Time To Live (TTL) in seconds. Defines how long content is cached. (in seconds)

Defines whether responses to requests with cookies must be stored in the cache.

Current status of the stage.

Date the cache stage was created. (RFC 3339 format)

Date the cache stage was last updated. (RFC 3339 format)

(UUID format)

Backend stage ID the cache stage is linked to. (UUID format)

(UUID format)

ID of the DNS stage.

Default Fully Qualified Domain Name provided for the Pipeline.

Custom Fully Qualified Domain Names configured (only the first one is valid).

Type of the stage.

Pipeline ID the DNS stage belongs to.

Current status of the stage.

Date the DNS stage was created. (RFC 3339 format)

Date the DNS stage was last updated. (RFC 3339 format)

TLS stage ID the DNS stage is linked to. (UUID format)

Cache stage ID the DNS stage is linked to. (UUID format)

Backend stage ID the DNS stage is linked to. (UUID format)

Support of wildcard (subdomains) for the given domain (a wildcard certificate is required to make it work).

Information on the currently-selected, active Edge Services subscription plan.

Cost to date (this month) for Edge Service subscription plans. This comprises the pro-rata cost of the current subscription plan, and any previous subscription plans that were active earlier in the month.

Total number of pipelines currently configured.

Cost to date (this month) of pipelines not included in the subscription plans.

Total amount of data egressed from the cache in gigabytes from the beginning of the month, for the active subscription plan.

Total amount of extra data egressed from cache in gigabytes from the beginning of the month, not included in the subscription plans.

Cost to date (this month) of the data egressed from the cache that is not included in the subscription plans.

Total number of requests processed by the WAF since the beginning of the current month, for the active subscription plan.

Total number of extra requests processed by the WAF from the beginning of the month, not included in the subscription plans.

Cost to date (this month) of the extra requests processed by the WAF that were not included in the subscription plans.

Cost of activating WAF add-on (where subscription plan does not include WAF).

Detailed costs and usage for all Edge Services subscription plans that were activated during the month.

Total cost to date (this month) of all Edge Services resources including active subscription plan, previously active plans, extra pipelines and extra egress cache data.

Modified or created head stage.

(UUID format)

Paginated list of backend stages.

Count of all backend stages matching the requested criteria.

Paginated list of cache stages.

Count of all cache stages matching the requested criteria.

Paginated list of DNS stages.

Count of all DNS stages matching the requested criteria.

Number of head stages to return per page.

Count of all head stages matching the requested pipeline_id.

(UUID format)

Paginated list of pipelines.

Count of all pipelines matching the requested criteria.

Paginated list of purge requests.

Count of all purge requests matching the requested criteria.

List of rules to be checked against every HTTP request. The first matching rule will forward the request to its specified backend stage. If no rules are matched, the request is forwarded to the stage defined by waf_stage_id or backend_stage_id.

Count of all route rules matching the requested criteria.

Paginated list of summarized route stages.

Count of all route stages matching the requested criteria.

Paginated list of TLS stages.

Count of all TLS stages matching the requested criteria.

Paginated list of WAF stages.

Count of all WAF stages matching the requested criteria.

(IP address)

ID of the pipeline.

Name of the pipeline.

Description of the pipeline.

Status of the pipeline.

Errors of the pipeline.

Project ID of the pipeline. (UUID format)

Organization ID of the pipeline.

Date the pipeline was created. (RFC 3339 format)

Date the pipeline was last updated. (RFC 3339 format)

Subscription plan name.

Amount of egress data from cache included in subscription plan.

Number of pipelines included in subscription plan.

Number of WAF requests included in subscription plan.

Number of backends per pipeline included in subscription plan.

Support of wildcard subdomains for the customized domain.

Cost to date (this month) for the corresponding Edge Services subscription plan.

ID of the purge request. (UUID format)

Pipeline ID the purge request belongs to. (UUID format)

Status of the purge request.

List of asserts to purge.

Defines whether to purge all content.

Date the purge request was created. (RFC 3339 format)

Date the purge request was last updated. (RFC 3339 format)

Rule condition to be matched. Requests matching the condition defined here will be directly forwarded to the backend specified by the backend_stage_id or waf_stage_id fields. Requests that do not match will be checked by the next rule's condition.

ID of the backend stage that requests matching the rule should be forwarded to. (UUID format)

Position of the rule which determines the order of processing within the route stage.

Route stage ID the route rule belongs to.

ID of the WAF stage that requests matching the rule should be forwarded to. (UUID format)

ID of the route stage.

Pipeline ID the route stage belongs to.

ID of the WAF stage HTTP requests should be forwarded to when no rules are matched. (UUID format)

ID of the backend stage HTTP requests should be forwarded to when no rules are matched. (UUID format)

Current status of the stage.

Date the route stage was created. (RFC 3339 format)

Date the route stage was last updated. (RFC 3339 format)

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 provided.

HTTP URL path to filter for. A request whose path matches the given filter will be considered to match the rule. All paths will match if none is provided.

Host to filter for. A request whose host matches the given filter will be considered to match the rule. All hosts will match if none is provided.

Type of filter to match for the HTTP URL path. For now, all path filters must be written in regex and use the regex type.

Value to be matched for the HTTP URL path.

ID of the Load Balancer. (UUID format)

Zone of the Load Balancer.

ID of the frontend linked to the Load Balancer. (UUID format)

Defines whether the Load Balancer's frontend handles SSL connections.

Fully Qualified Domain Name (in the format subdomain.example.com) to use in HTTP requests sent towards your Load Balancer.

Defines whether to forward websocket requests to the load balancer.

Load Balancer information.

Name of the Bucket.

Region of the Bucket.

Defines whether the bucket website feature is enabled.

The region you want to target

(UUID format)

The region you want to target

(UUID format)

(UUID format)

(UUID format)

(UUID format)

(UUID format)

Rule condition to be matched. Requests matching the condition defined here will be directly forwarded to the backend specified by the backend_stage_id or waf_stage_id fields. Requests that do not match will be checked by the next rule's condition.

ID of the backend stage that requests matching the rule should be forwarded to. (UUID format)

ID of the WAF stage that requests matching the rule should be forwarded to. (UUID format)

List of rules to be checked against every HTTP request. The first matching rule will forward the request to its specified backend stage. If no rules are matched, the request is forwarded to the stage defined by waf_stage_id or backend_stage_id.

ID of the Secret.

Region of the Secret.

Secret information (from Secret Manager).

ID of the TLS stage.

Secret (from Scaleway Secret Manager) containing your custom certificate.

True when Scaleway generates and manages a Let's Encrypt certificate for the TLS stage/custom endpoint.

Pipeline ID the TLS stage belongs to.

Expiration date of the certificate. (RFC 3339 format)

Current status of the stage.

Date the TLS stage was created. (RFC 3339 format)

Date the TLS stage was last updated. (RFC 3339 format)

Cache stage ID the TLS stage is linked to. (UUID format)

Backend stage ID the TLS stage is linked to. (UUID format)

(UUID format)

(UUID format)

ID of the WAF stage.

Pipeline ID the WAF stage belongs to.

Mode defining WAF behavior (disable/log_only/enable).

Sensitivity 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.

Current status of the stage.

Date the WAF stage was created. (RFC 3339 format)

Date the WAF stage was last updated. (RFC 3339 format)

ID of the backend stage to forward requests to after the WAF stage. (UUID format)

List of OWASP® CRS rule IDs excluded from WAF.