> ## Documentation Index
> Fetch the complete documentation index at: https://cloud.laravel.com/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# List rules

> Get the rules of a ruleset, in the order they are evaluated. To move a rule, update it with a `position`.

**Required permission:** `edge_network.view`


## OpenAPI

````yaml https://cloud.laravel.com/api-docs/api.json get /edge-networks/{edgeNetwork}/rulesets/{ruleset}/rules
openapi: 3.1.0
info:
  title: Laravel Cloud
  version: 0.0.1
servers:
  - url: https://cloud.laravel.com/api
security:
  - http: []
tags:
  - name: Applications
  - name: Environments
  - name: Domains
  - name: Commands
  - name: Deployments
  - name: Instances
  - name: Email
  - name: Background Processes
  - name: Scheduled Commands
  - name: Database Clusters
  - name: Databases
  - name: Database Users
  - name: Database Snapshots
  - name: Database Restores
  - name: Object Storage Buckets
  - name: Bucket Keys
  - name: Caches
  - name: WebSocket Clusters
  - name: WebSocket Applications
  - name: Dedicated Clusters
  - name: Edge Networks
  - name: Secrets
  - name: Usage
  - name: Meta
  - name: Databases (Legacy)
paths:
  /edge-networks/{edgeNetwork}/rulesets/{ruleset}/rules:
    get:
      tags:
        - Edge Networks
      summary: List rules
      description: >-
        Get the rules of a ruleset, in the order they are evaluated. To move a
        rule, update it with a `position`.
      operationId: public.edge-networks.rulesets.rules.index
      parameters:
        - name: edgeNetwork
          in: path
          required: true
          description: The edge network identifier
          schema:
            type: string
        - name: ruleset
          in: path
          required: true
          description: The ruleset, one per type on each dedicated edge network.
          schema:
            type: string
            description: >-
              The ruleset.


              - `rate-limit`: Rules that limit how many matching requests each
              visitor can make.

              - `cache`: Rules that control how matching responses are cached at
              the edge and in browsers.

              - `firewall`: Custom WAF rules that block, challenge, log or skip
              matching requests.
            enum:
              - rate-limit
              - cache
              - firewall
      responses:
        '200':
          description: Array of `EdgeNetworkRuleResource`
          content:
            application/vnd.api+json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/EdgeNetworkRuleResource'
                required:
                  - data
        '403':
          $ref: '#/components/responses/AuthorizationException'
        '404':
          $ref: '#/components/responses/ModelNotFoundException'
components:
  schemas:
    EdgeNetworkRuleResource:
      type: object
      properties:
        id:
          type: string
        type:
          type: string
          enum:
            - edge_network_rules
        attributes:
          type: object
          properties:
            type:
              type: string
              description: The type of the ruleset the rule belongs to.
              enum:
                - firewall
                - rate_limit
                - cache
            name:
              type: string
            description:
              type:
                - string
                - 'null'
            is_active:
              type: boolean
              description: >-
                Whether the rule applies. An inactive rule keeps its position
                but matches no requests.
            settings:
              description: >-
                The rule's action and conditions. The keys depend on the ruleset
                type and match the `settings` accepted when creating or updating
                a rule.
              oneOf:
                - title: Rate limit
                  type: object
                  description: >-
                    Settings for rules in the `rate-limit` ruleset. Rules that
                    limit how many matching requests each visitor can make.
                  examples:
                    - requests_per_period: 10
                      period: 60
                      action: managed_challenge
                      throttles: false
                      action_duration: 600
                      criteria_groups:
                        - criterias:
                            - criteria: value
                              field: uri_path
                              operator: equals
                              value: /login
                            - criteria: value
                              field: request_method
                              operator: equals
                              value: POST
                  properties:
                    requests_per_period:
                      type: integer
                      description: >-
                        How many matching requests can be made in each `period`.
                        Requests are counted per `counting_key` value and per
                        Cloudflare data center.
                      minimum: 1
                    period:
                      type: integer
                      description: |-
                        The window, in seconds, in which requests are counted.

                        - `10`: 10 seconds
                        - `15`: 15 seconds
                        - `20`: 20 seconds
                        - `30`: 30 seconds
                        - `40`: 40 seconds
                        - `45`: 45 seconds
                        - `60`: 1 minute
                        - `90`: 90 seconds
                        - `120`: 2 minutes
                        - `180`: 3 minutes
                        - `300`: 5 minutes
                        - `480`: 8 minutes
                        - `600`: 10 minutes
                        - `900`: 15 minutes
                        - `1200`: 20 minutes
                        - `1800`: 30 minutes
                        - `2400`: 40 minutes
                        - `3600`: 1 hour
                      enum:
                        - 10
                        - 15
                        - 20
                        - 30
                        - 40
                        - 45
                        - 60
                        - 90
                        - 120
                        - 180
                        - 300
                        - 480
                        - 600
                        - 900
                        - 1200
                        - 1800
                        - 2400
                        - 3600
                    action:
                      type: string
                      description: |-
                        What to do once a visitor exceeds the limit.

                        - `block`: Block
                        - `managed_challenge`: Managed challenge
                        - `js_challenge`: JS challenge
                      enum:
                        - block
                        - managed_challenge
                        - js_challenge
                    throttles:
                      type: boolean
                      description: >-
                        When true, the action only applies to requests above the
                        limit. When false, it applies to every matching request
                        from the visitor for `action_duration`.
                    action_duration:
                      type: integer
                      description: >-
                        How long, in seconds, the action applies once a visitor
                        exceeds the limit. Required when `throttles` is false,
                        and must be at least `period`.


                        - `10`: 10 seconds

                        - `15`: 15 seconds

                        - `20`: 20 seconds

                        - `30`: 30 seconds

                        - `40`: 40 seconds

                        - `45`: 45 seconds

                        - `60`: 1 minute

                        - `90`: 90 seconds

                        - `120`: 2 minutes

                        - `180`: 3 minutes

                        - `300`: 5 minutes

                        - `480`: 8 minutes

                        - `600`: 10 minutes

                        - `900`: 15 minutes

                        - `1200`: 20 minutes

                        - `1800`: 30 minutes

                        - `2400`: 40 minutes

                        - `3600`: 1 hour

                        - `86400`: 1 day
                      enum:
                        - 10
                        - 15
                        - 20
                        - 30
                        - 40
                        - 45
                        - 60
                        - 90
                        - 120
                        - 180
                        - 300
                        - 480
                        - 600
                        - 900
                        - 1200
                        - 1800
                        - 2400
                        - 3600
                        - 86400
                    counting_key:
                      type: string
                      description: >-
                        What requests are grouped by when counting them against
                        the limit.


                        - `visitor`: Each visitor gets their own limit.

                        - `asn`: Every address in the same network shares one
                        limit.

                        - `user_agent`: Every request with the same user agent
                        shares one limit.

                        - `header`: Every request with the same header value
                        shares one limit.
                      enum:
                        - visitor
                        - asn
                        - user_agent
                        - header
                      default: visitor
                    counting_header:
                      type:
                        - string
                        - 'null'
                      description: >-
                        The lowercase name of the header whose value requests
                        are grouped by. Required when `counting_key` is
                        `header`. Requests without the header share one count.
                      maxLength: 100
                    criteria_groups:
                      type: array
                      description: >-
                        The conditions a request must match. A request matches
                        when every condition in at least one group matches, so
                        groups `[A, B]` and `[C]` match when A and B match, or
                        when C matches. A rule takes up to 20 conditions, and
                        each group after the first counts as one more.
                      items:
                        type: object
                        properties:
                          criterias:
                            type: array
                            description: The conditions of the group, which must all match.
                            items:
                              type: object
                              properties:
                                criteria:
                                  type: string
                                  description: >-
                                    The kind of condition. Each field and
                                    operator pair accepts one kind, listed as
                                    `criteria_identifier` by the Get a ruleset
                                    endpoint.


                                    - `value`: Compares the field with one
                                    value.

                                    - `array`: Compares the field with a list of
                                    values.

                                    - `boolean`: Checks a field that is true or
                                    false.

                                    - `key_value`: Compares one entry of a field
                                    that takes a `key`, such as a header, with
                                    one value.

                                    - `key_array`: Compares one entry of a field
                                    that takes a `key`, such as a header, with a
                                    list of values.
                                  enum:
                                    - value
                                    - array
                                    - boolean
                                    - key_value
                                    - key_array
                                field:
                                  type: string
                                  description: >-
                                    The request field to match.


                                    | Field | Matches | Operators |

                                    |---|---|---|

                                    | `as_num` | AS num | `equals`,
                                    `not_equals`, `greater_than`, `less_than`,
                                    `greater_than_or_equal`,
                                    `less_than_or_equal`, `in`, `not_in` |

                                    | `authentication_detected` | Authentication
                                    | `none` |

                                    | `body` | Body | `equals`, `not_equals`,
                                    `contains`, `not_contains`, `matches`,
                                    `not_matches`, `start_with`,
                                    `not_start_with`, `end_with`, `not_end_with`
                                    |

                                    | `body_size` | Body size | `equals`,
                                    `not_equals`, `greater_than`, `less_than`,
                                    `greater_than_or_equal`,
                                    `less_than_or_equal`, `in`, `not_in` |

                                    | `bot_detection_ids` | Bot detection IDs |
                                    `equals`, `not_equals`, `in`, `not_in`,
                                    `start_with`, `not_start_with`, `end_with`,
                                    `not_end_with` |

                                    | `bot_score` | Bot score | `equals`,
                                    `not_equals`, `greater_than`, `less_than`,
                                    `greater_than_or_equal`,
                                    `less_than_or_equal`, `in`, `not_in` |

                                    | `client_certificate_verified` | Client
                                    certificate | `none` |

                                    | `continent` | Continent | `equals`,
                                    `not_equals`, `in`, `not_in` |

                                    | `cookie` | Cookie | `wildcard`,
                                    `strict_wildcard`, `equals`, `not_equals`,
                                    `contains`, `not_contains`, `matches`,
                                    `not_matches`, `start_with`,
                                    `not_start_with`, `end_with`, `not_end_with`
                                    |

                                    | `cookie_value` | Cookie value of |
                                    `exists`, `not_exists`, `equals`,
                                    `not_equals`, `contains`, `not_contains`,
                                    `matches`, `not_matches`, `start_with`,
                                    `not_start_with`, `end_with`,
                                    `not_end_with`, `in`, `not_in` |

                                    | `country` | Country | `equals`,
                                    `not_equals`, `in`, `not_in` |

                                    | `environment` | Cloud environment |
                                    `equals`, `not_equals`, `in`, `not_in` |

                                    | `header` | Header | `exists`,
                                    `not_exists`, `equals`, `not_equals`,
                                    `contains`, `not_contains`, `matches`,
                                    `not_matches`, `start_with`,
                                    `not_start_with`, `end_with`,
                                    `not_end_with`, `in`, `not_in` |

                                    | `hostname` | Hostname | `wildcard`,
                                    `strict_wildcard`, `equals`, `not_equals`,
                                    `contains`, `not_contains`, `matches`,
                                    `not_matches`, `start_with`,
                                    `not_start_with`, `end_with`,
                                    `not_end_with`, `in`, `not_in` |

                                    | `http_version` | HTTP version | `equals`,
                                    `not_equals`, `in`, `not_in`, `start_with`,
                                    `not_start_with`, `end_with`, `not_end_with`
                                    |

                                    | `ip_source_address` | IP source address |
                                    `equals`, `not_equals`, `in`, `not_in` |

                                    | `ja4_fingerprint` | JA4 fingerprint |
                                    `equals`, `not_equals`, `start_with`,
                                    `not_start_with`, `end_with`,
                                    `not_end_with`, `in`, `not_in` |

                                    | `json_string` | JSON string | `equals`,
                                    `not_equals`, `contains`, `not_contains`,
                                    `matches`, `not_matches`, `start_with`,
                                    `not_start_with`, `end_with`,
                                    `not_end_with`, `in`, `not_in` |

                                    | `known_bots` | Bots | `none` |

                                    | `mime_type` | MIME type | `wildcard`,
                                    `strict_wildcard`, `equals`, `not_equals`,
                                    `contains`, `not_contains`, `matches`,
                                    `not_matches`, `start_with`,
                                    `not_start_with`, `end_with`,
                                    `not_end_with`, `in`, `not_in` |

                                    | `password_leaked` | Password leak | `none`
                                    |

                                    | `referer` | Referer | `wildcard`,
                                    `strict_wildcard`, `equals`, `not_equals`,
                                    `contains`, `not_contains`, `matches`,
                                    `not_matches`, `start_with`,
                                    `not_start_with`, `end_with`, `not_end_with`
                                    |

                                    | `request_method` | Request method |
                                    `equals`, `not_equals`, `start_with`,
                                    `not_start_with`, `end_with`,
                                    `not_end_with`, `in`, `not_in` |

                                    | `serves_static_resource` | Static resource
                                    | `none` |

                                    | `similar_password_leaked` | Similar
                                    password leak | `none` |

                                    | `ssl_https` | SSL/HTTPS | `none` |

                                    | `uri` | URI | `wildcard`,
                                    `strict_wildcard`, `equals`, `not_equals`,
                                    `contains`, `not_contains`, `matches`,
                                    `not_matches`, `start_with`,
                                    `not_start_with`, `end_with`, `not_end_with`
                                    |

                                    | `uri_full` | URI full | `wildcard`,
                                    `strict_wildcard`, `equals`, `not_equals`,
                                    `contains`, `not_contains`, `matches`,
                                    `not_matches`, `start_with`,
                                    `not_start_with`, `end_with`, `not_end_with`
                                    |

                                    | `uri_path` | URI path | `wildcard`,
                                    `strict_wildcard`, `equals`, `not_equals`,
                                    `contains`, `not_contains`, `matches`,
                                    `not_matches`, `start_with`,
                                    `not_start_with`, `end_with`,
                                    `not_end_with`, `in`, `not_in` |

                                    | `uri_query_string` | URI query string |
                                    `wildcard`, `strict_wildcard`, `equals`,
                                    `not_equals`, `contains`, `not_contains`,
                                    `matches`, `not_matches`, `start_with`,
                                    `not_start_with`, `end_with`, `not_end_with`
                                    |

                                    | `user_agent` | User agent | `wildcard`,
                                    `strict_wildcard`, `equals`, `not_equals`,
                                    `contains`, `not_contains`, `matches`,
                                    `not_matches`, `start_with`,
                                    `not_start_with`, `end_with`, `not_end_with`
                                    |

                                    | `username_and_password_leaked` | Username
                                    and password leak | `none` |

                                    | `username_leaked` | Username | `none` |

                                    | `verified_bot` | Bot verification | `none`
                                    |

                                    | `verified_bot_category` | Verified bot
                                    category | `in`, `not_in`, `equals`,
                                    `not_equals` |

                                    | `waf_attack_score` | WAF attack score |
                                    `equals`, `not_equals`, `greater_than`,
                                    `less_than`, `greater_than_or_equal`,
                                    `less_than_or_equal`, `in`, `not_in` |

                                    | `waf_rce_attack_score` | WAF RCE attack
                                    score | `equals`, `not_equals`,
                                    `greater_than`, `less_than`,
                                    `greater_than_or_equal`,
                                    `less_than_or_equal`, `in`, `not_in` |

                                    | `waf_sqli_attack_score` | WAF SQLi attack
                                    score | `equals`, `not_equals`,
                                    `greater_than`, `less_than`,
                                    `greater_than_or_equal`,
                                    `less_than_or_equal`, `in`, `not_in` |

                                    | `waf_xss_attack_score` | WAF XSS attack
                                    score | `equals`, `not_equals`,
                                    `greater_than`, `less_than`,
                                    `greater_than_or_equal`,
                                    `less_than_or_equal`, `in`, `not_in` |

                                    | `x_forwarded_for` | X-Forwarded-For |
                                    `wildcard`, `strict_wildcard`, `equals`,
                                    `not_equals`, `contains`, `not_contains`,
                                    `matches`, `not_matches`, `start_with`,
                                    `not_start_with`, `end_with`, `not_end_with`
                                    |
                                  enum:
                                    - as_num
                                    - authentication_detected
                                    - body
                                    - body_size
                                    - bot_detection_ids
                                    - bot_score
                                    - client_certificate_verified
                                    - continent
                                    - cookie
                                    - cookie_value
                                    - country
                                    - environment
                                    - header
                                    - hostname
                                    - http_version
                                    - ip_source_address
                                    - ja4_fingerprint
                                    - json_string
                                    - known_bots
                                    - mime_type
                                    - password_leaked
                                    - referer
                                    - request_method
                                    - serves_static_resource
                                    - similar_password_leaked
                                    - ssl_https
                                    - uri
                                    - uri_full
                                    - uri_path
                                    - uri_query_string
                                    - user_agent
                                    - username_and_password_leaked
                                    - username_leaked
                                    - verified_bot
                                    - verified_bot_category
                                    - waf_attack_score
                                    - waf_rce_attack_score
                                    - waf_sqli_attack_score
                                    - waf_xss_attack_score
                                    - x_forwarded_for
                                operator:
                                  type: string
                                  description: >-
                                    How to compare the field.


                                    - `equals`: equals

                                    - `not_equals`: not equals

                                    - `greater_than`: greater than

                                    - `less_than`: less than

                                    - `greater_than_or_equal`: greater than or
                                    equal

                                    - `less_than_or_equal`: less than or equal

                                    - `in`: in

                                    - `not_in`: not in

                                    - `none`: none

                                    - `contains`: contains

                                    - `not_contains`: not contains

                                    - `matches`: matches

                                    - `not_matches`: not matches

                                    - `start_with`: start with

                                    - `not_start_with`: not start with

                                    - `end_with`: end with

                                    - `not_end_with`: not end with

                                    - `wildcard`: wildcard

                                    - `strict_wildcard`: strict wildcard

                                    - `exists`: exists

                                    - `not_exists`: not exists
                                  enum:
                                    - equals
                                    - not_equals
                                    - greater_than
                                    - less_than
                                    - greater_than_or_equal
                                    - less_than_or_equal
                                    - in
                                    - not_in
                                    - none
                                    - contains
                                    - not_contains
                                    - matches
                                    - not_matches
                                    - start_with
                                    - not_start_with
                                    - end_with
                                    - not_end_with
                                    - wildcard
                                    - strict_wildcard
                                    - exists
                                    - not_exists
                                key:
                                  type: string
                                  description: >-
                                    The entry to match for `key_value` and
                                    `key_array` conditions, such as a header
                                    name. Header names must be lowercase.
                                value:
                                  description: >-
                                    The value to compare with: a string, number
                                    or boolean, or a list for `array` and
                                    `key_array` conditions. Fields with options,
                                    such as `environment`, only accept the
                                    values listed by the Get a ruleset endpoint.
                              required:
                                - criteria
                                - field
                                - operator
                            minItems: 1
                        required:
                          - criterias
                      minItems: 1
                  required:
                    - requests_per_period
                    - period
                    - throttles
                    - action
                    - criteria_groups
                - title: Cache
                  type: object
                  description: >-
                    Settings for rules in the `cache` ruleset. Rules that
                    control how matching responses are cached at the edge and in
                    browsers.
                  examples:
                    - action: set_cache_settings
                      cache: true
                      edge_ttl_mode: override_origin
                      edge_ttl: 3600
                      browser_ttl_mode: respect_origin
                      respect_strong_etags: false
                      serve_stale: true
                      origin_error_page_passthru: false
                      criteria_groups:
                        - criterias:
                            - criteria: value
                              field: uri_path
                              operator: equals
                              value: /pricing
                  properties:
                    action:
                      type: string
                      description: |-
                        Cache rules always set cache settings.

                        - `set_cache_settings`: Set cache settings
                      enum:
                        - set_cache_settings
                    cache:
                      type: boolean
                      description: >-
                        Whether matching responses are eligible for caching.
                        False bypasses the cache.
                    edge_ttl_mode:
                      type: string
                      description: >-
                        How long responses stay cached at the edge.


                        - `respect_origin`: Use cache-control header or respect
                        origin TTL

                        - `bypass_by_default`: Use cache-control header or
                        bypass

                        - `override_origin`: Ignore cache-control header and use
                        custom TTL
                      enum:
                        - respect_origin
                        - bypass_by_default
                        - override_origin
                    edge_ttl:
                      type:
                        - integer
                        - 'null'
                      description: >-
                        Seconds to cache responses at the edge. Required when
                        `edge_ttl_mode` is `override_origin`.
                      minimum: 1
                    browser_ttl_mode:
                      type: string
                      description: |-
                        How long browsers cache responses.

                        - `respect_origin`: Respect origin TTL
                        - `bypass`: Bypass cache
                        - `override_origin`: Override origin and use custom TTL
                      enum:
                        - respect_origin
                        - bypass
                        - override_origin
                    browser_ttl:
                      type:
                        - integer
                        - 'null'
                      description: >-
                        Seconds browsers cache responses. Required when
                        `browser_ttl_mode` is `override_origin`.
                      minimum: 1
                    respect_strong_etags:
                      type: boolean
                      description: >-
                        Keep strong ETags from the origin instead of converting
                        them to weak ones.
                    serve_stale:
                      type: boolean
                      description: >-
                        Serve stale content while a cached response is being
                        revalidated.
                    origin_error_page_passthru:
                      type: boolean
                      description: >-
                        Pass 5xx error pages from the origin through instead of
                        serving the edge error page.
                    criteria_groups:
                      type: array
                      description: >-
                        The conditions a request must match. A request matches
                        when every condition in at least one group matches, so
                        groups `[A, B]` and `[C]` match when A and B match, or
                        when C matches. A rule takes up to 20 conditions, and
                        each group after the first counts as one more.
                      items:
                        type: object
                        properties:
                          criterias:
                            type: array
                            description: The conditions of the group, which must all match.
                            items:
                              type: object
                              properties:
                                criteria:
                                  type: string
                                  description: >-
                                    The kind of condition. Each field and
                                    operator pair accepts one kind, listed as
                                    `criteria_identifier` by the Get a ruleset
                                    endpoint.


                                    - `value`: Compares the field with one
                                    value.

                                    - `array`: Compares the field with a list of
                                    values.

                                    - `boolean`: Checks a field that is true or
                                    false.

                                    - `key_value`: Compares one entry of a field
                                    that takes a `key`, such as a header, with
                                    one value.

                                    - `key_array`: Compares one entry of a field
                                    that takes a `key`, such as a header, with a
                                    list of values.
                                  enum:
                                    - value
                                    - array
                                    - boolean
                                    - key_value
                                    - key_array
                                field:
                                  type: string
                                  description: >-
                                    The request field to match.


                                    | Field | Matches | Operators |

                                    |---|---|---|

                                    | `cookie` | Cookie | `wildcard`,
                                    `strict_wildcard`, `equals`, `not_equals`,
                                    `contains`, `not_contains`, `matches`,
                                    `not_matches`, `start_with`,
                                    `not_start_with`, `end_with`, `not_end_with`
                                    |

                                    | `cookie_value` | Cookie value of |
                                    `exists`, `not_exists`, `equals`,
                                    `not_equals`, `contains`, `not_contains`,
                                    `matches`, `not_matches`, `start_with`,
                                    `not_start_with`, `end_with`,
                                    `not_end_with`, `in`, `not_in` |

                                    | `file_extension` | File extension |
                                    `equals`, `not_equals`, `contains`,
                                    `not_contains`, `matches`, `not_matches`,
                                    `start_with`, `not_start_with`, `end_with`,
                                    `not_end_with`, `in`, `not_in` |

                                    | `header` | Header | `exists`,
                                    `not_exists`, `equals`, `not_equals`,
                                    `contains`, `not_contains`, `matches`,
                                    `not_matches`, `start_with`,
                                    `not_start_with`, `end_with`,
                                    `not_end_with`, `in`, `not_in` |

                                    | `hostname` | Hostname | `wildcard`,
                                    `strict_wildcard`, `equals`, `not_equals`,
                                    `contains`, `not_contains`, `matches`,
                                    `not_matches`, `start_with`,
                                    `not_start_with`, `end_with`,
                                    `not_end_with`, `in`, `not_in` |

                                    | `referer` | Referer | `wildcard`,
                                    `strict_wildcard`, `equals`, `not_equals`,
                                    `contains`, `not_contains`, `matches`,
                                    `not_matches`, `start_with`,
                                    `not_start_with`, `end_with`, `not_end_with`
                                    |

                                    | `ssl_https` | SSL/HTTPS | `none` |

                                    | `uri` | URI | `wildcard`,
                                    `strict_wildcard`, `equals`, `not_equals`,
                                    `contains`, `not_contains`, `matches`,
                                    `not_matches`, `start_with`,
                                    `not_start_with`, `end_with`, `not_end_with`
                                    |

                                    | `uri_full` | URI full | `wildcard`,
                                    `strict_wildcard`, `equals`, `not_equals`,
                                    `contains`, `not_contains`, `matches`,
                                    `not_matches`, `start_with`,
                                    `not_start_with`, `end_with`, `not_end_with`
                                    |

                                    | `uri_path` | URI path | `wildcard`,
                                    `strict_wildcard`, `equals`, `not_equals`,
                                    `contains`, `not_contains`, `matches`,
                                    `not_matches`, `start_with`,
                                    `not_start_with`, `end_with`,
                                    `not_end_with`, `in`, `not_in` |

                                    | `uri_query_string` | URI query string |
                                    `wildcard`, `strict_wildcard`, `equals`,
                                    `not_equals`, `contains`, `not_contains`,
                                    `matches`, `not_matches`, `start_with`,
                                    `not_start_with`, `end_with`, `not_end_with`
                                    |

                                    | `user_agent` | User agent | `wildcard`,
                                    `strict_wildcard`, `equals`, `not_equals`,
                                    `contains`, `not_contains`, `matches`,
                                    `not_matches`, `start_with`,
                                    `not_start_with`, `end_with`, `not_end_with`
                                    |

                                    | `x_forwarded_for` | X-Forwarded-For |
                                    `wildcard`, `strict_wildcard`, `equals`,
                                    `not_equals`, `contains`, `not_contains`,
                                    `matches`, `not_matches`, `start_with`,
                                    `not_start_with`, `end_with`, `not_end_with`
                                    |
                                  enum:
                                    - cookie
                                    - cookie_value
                                    - file_extension
                                    - header
                                    - hostname
                                    - referer
                                    - ssl_https
                                    - uri
                                    - uri_full
                                    - uri_path
                                    - uri_query_string
                                    - user_agent
                                    - x_forwarded_for
                                operator:
                                  type: string
                                  description: |-
                                    How to compare the field.

                                    - `wildcard`: wildcard
                                    - `strict_wildcard`: strict wildcard
                                    - `equals`: equals
                                    - `not_equals`: not equals
                                    - `contains`: contains
                                    - `not_contains`: not contains
                                    - `matches`: matches
                                    - `not_matches`: not matches
                                    - `start_with`: start with
                                    - `not_start_with`: not start with
                                    - `end_with`: end with
                                    - `not_end_with`: not end with
                                    - `exists`: exists
                                    - `not_exists`: not exists
                                    - `in`: in
                                    - `not_in`: not in
                                    - `none`: none
                                  enum:
                                    - wildcard
                                    - strict_wildcard
                                    - equals
                                    - not_equals
                                    - contains
                                    - not_contains
                                    - matches
                                    - not_matches
                                    - start_with
                                    - not_start_with
                                    - end_with
                                    - not_end_with
                                    - exists
                                    - not_exists
                                    - in
                                    - not_in
                                    - none
                                key:
                                  type: string
                                  description: >-
                                    The entry to match for `key_value` and
                                    `key_array` conditions, such as a header
                                    name. Header names must be lowercase.
                                value:
                                  description: >-
                                    The value to compare with: a string, number
                                    or boolean, or a list for `array` and
                                    `key_array` conditions. Fields with options,
                                    such as `environment`, only accept the
                                    values listed by the Get a ruleset endpoint.
                              required:
                                - criteria
                                - field
                                - operator
                            minItems: 1
                        required:
                          - criterias
                      minItems: 1
                  required:
                    - cache
                    - edge_ttl_mode
                    - browser_ttl_mode
                    - respect_strong_etags
                    - serve_stale
                    - origin_error_page_passthru
                    - action
                    - criteria_groups
                - title: Firewall
                  type: object
                  description: >-
                    Settings for rules in the `firewall` ruleset. Custom WAF
                    rules that block, challenge, log or skip matching requests.
                  examples:
                    - action: block
                      criteria_groups:
                        - criterias:
                            - criteria: value
                              field: uri_path
                              operator: equals
                              value: /wp-login.php
                        - criterias:
                            - criteria: value
                              field: uri_path
                              operator: equals
                              value: /xmlrpc.php
                  properties:
                    action:
                      type: string
                      description: |-
                        What to do with matching requests.

                        - `block`: Block
                        - `managed_challenge`: Managed challenge
                        - `challenge`: Challenge
                        - `js_challenge`: JS challenge
                        - `log`: Log
                        - `skip`: Skip
                      enum:
                        - block
                        - managed_challenge
                        - challenge
                        - js_challenge
                        - log
                        - skip
                    skip_parameters:
                      type: object
                      description: >-
                        What a `skip` rule skips. Required when `action` is
                        `skip`.
                      properties:
                        skip_current_ruleset:
                          type: boolean
                          description: Skip the remaining rules in this ruleset.
                        phases:
                          type: array
                          items:
                            type: string
                            description: >-
                              Rules to skip.


                              - `http_ratelimit`: All rate limiting rules

                              - `http_request_firewall_managed`: All managed
                              rules

                              - `http_request_sbfm`: All Super Bot Fight Mode
                              rules
                            enum:
                              - http_ratelimit
                              - http_request_firewall_managed
                              - http_request_sbfm
                        products:
                          type: array
                          items:
                            type: string
                            description: >-
                              Security features to skip.


                              - `zoneLockdown`: Zone Lockdown

                              - `uaBlock`: User Agent Blocking

                              - `bic`: Browser Integrity Check

                              - `hot`: Hotlink Protection

                              - `securityLevel`: Security Level

                              - `rateLimit`: Rate limiting rules (previous
                              version)

                              - `waf`: Managed rules (previous version)
                            enum:
                              - zoneLockdown
                              - uaBlock
                              - bic
                              - hot
                              - securityLevel
                              - rateLimit
                              - waf
                    block_parameters:
                      type: object
                      description: >-
                        The response sent to blocked requests. Only used when
                        `action` is `block`. Without it, the default block page
                        is sent.
                      properties:
                        response_type:
                          type: string
                          description: |-
                            The response to send.

                            - `default`: Default block page
                            - `html`: Custom HTML
                            - `text`: Custom text
                            - `json`: Custom JSON
                            - `xml`: Custom XML
                          enum:
                            - default
                            - html
                            - text
                            - json
                            - xml
                          default: default
                        status_code:
                          type: integer
                          description: The status code of a custom response.
                          default: 403
                          minimum: 400
                          maximum: 499
                        content:
                          type: string
                          description: >-
                            The body of a custom response. Required when
                            `response_type` is not `default`.
                          maxLength: 10240
                    criteria_groups:
                      type: array
                      description: >-
                        The conditions a request must match. A request matches
                        when every condition in at least one group matches, so
                        groups `[A, B]` and `[C]` match when A and B match, or
                        when C matches. A rule takes up to 20 conditions, and
                        each group after the first counts as one more.
                      items:
                        type: object
                        properties:
                          criterias:
                            type: array
                            description: The conditions of the group, which must all match.
                            items:
                              type: object
                              properties:
                                criteria:
                                  type: string
                                  description: >-
                                    The kind of condition. Each field and
                                    operator pair accepts one kind, listed as
                                    `criteria_identifier` by the Get a ruleset
                                    endpoint.


                                    - `value`: Compares the field with one
                                    value.

                                    - `array`: Compares the field with a list of
                                    values.

                                    - `boolean`: Checks a field that is true or
                                    false.

                                    - `key_value`: Compares one entry of a field
                                    that takes a `key`, such as a header, with
                                    one value.

                                    - `key_array`: Compares one entry of a field
                                    that takes a `key`, such as a header, with a
                                    list of values.
                                  enum:
                                    - value
                                    - array
                                    - boolean
                                    - key_value
                                    - key_array
                                field:
                                  type: string
                                  description: >-
                                    The request field to match.


                                    | Field | Matches | Operators |

                                    |---|---|---|

                                    | `as_num` | AS num | `equals`,
                                    `not_equals`, `greater_than`, `less_than`,
                                    `greater_than_or_equal`,
                                    `less_than_or_equal`, `in`, `not_in` |

                                    | `authentication_detected` | Authentication
                                    | `none` |

                                    | `body` | Body | `equals`, `not_equals`,
                                    `contains`, `not_contains`, `matches`,
                                    `not_matches`, `start_with`,
                                    `not_start_with`, `end_with`, `not_end_with`
                                    |

                                    | `body_size` | Body size | `equals`,
                                    `not_equals`, `greater_than`, `less_than`,
                                    `greater_than_or_equal`,
                                    `less_than_or_equal`, `in`, `not_in` |

                                    | `bot_detection_ids` | Bot detection IDs |
                                    `equals`, `not_equals`, `in`, `not_in`,
                                    `start_with`, `not_start_with`, `end_with`,
                                    `not_end_with` |

                                    | `bot_score` | Bot score | `equals`,
                                    `not_equals`, `greater_than`, `less_than`,
                                    `greater_than_or_equal`,
                                    `less_than_or_equal`, `in`, `not_in` |

                                    | `client_certificate_verified` | Client
                                    certificate | `none` |

                                    | `continent` | Continent | `equals`,
                                    `not_equals`, `in`, `not_in` |

                                    | `cookie` | Cookie | `wildcard`,
                                    `strict_wildcard`, `equals`, `not_equals`,
                                    `contains`, `not_contains`, `matches`,
                                    `not_matches`, `start_with`,
                                    `not_start_with`, `end_with`, `not_end_with`
                                    |

                                    | `cookie_value` | Cookie value of |
                                    `exists`, `not_exists`, `equals`,
                                    `not_equals`, `contains`, `not_contains`,
                                    `matches`, `not_matches`, `start_with`,
                                    `not_start_with`, `end_with`,
                                    `not_end_with`, `in`, `not_in` |

                                    | `country` | Country | `equals`,
                                    `not_equals`, `in`, `not_in` |

                                    | `environment` | Cloud environment |
                                    `equals`, `not_equals`, `in`, `not_in` |

                                    | `header` | Header | `exists`,
                                    `not_exists`, `equals`, `not_equals`,
                                    `contains`, `not_contains`, `matches`,
                                    `not_matches`, `start_with`,
                                    `not_start_with`, `end_with`,
                                    `not_end_with`, `in`, `not_in` |

                                    | `hostname` | Hostname | `wildcard`,
                                    `strict_wildcard`, `equals`, `not_equals`,
                                    `contains`, `not_contains`, `matches`,
                                    `not_matches`, `start_with`,
                                    `not_start_with`, `end_with`,
                                    `not_end_with`, `in`, `not_in` |

                                    | `http_version` | HTTP version | `equals`,
                                    `not_equals`, `in`, `not_in`, `start_with`,
                                    `not_start_with`, `end_with`, `not_end_with`
                                    |

                                    | `ip_source_address` | IP source address |
                                    `equals`, `not_equals`, `in`, `not_in` |

                                    | `ja4_fingerprint` | JA4 fingerprint |
                                    `equals`, `not_equals`, `start_with`,
                                    `not_start_with`, `end_with`,
                                    `not_end_with`, `in`, `not_in` |

                                    | `json_string` | JSON string | `equals`,
                                    `not_equals`, `contains`, `not_contains`,
                                    `matches`, `not_matches`, `start_with`,
                                    `not_start_with`, `end_with`,
                                    `not_end_with`, `in`, `not_in` |

                                    | `known_bots` | Bots | `none` |

                                    | `mime_type` | MIME type | `wildcard`,
                                    `strict_wildcard`, `equals`, `not_equals`,
                                    `contains`, `not_contains`, `matches`,
                                    `not_matches`, `start_with`,
                                    `not_start_with`, `end_with`,
                                    `not_end_with`, `in`, `not_in` |

                                    | `password_leaked` | Password leak | `none`
                                    |

                                    | `referer` | Referer | `wildcard`,
                                    `strict_wildcard`, `equals`, `not_equals`,
                                    `contains`, `not_contains`, `matches`,
                                    `not_matches`, `start_with`,
                                    `not_start_with`, `end_with`, `not_end_with`
                                    |

                                    | `request_method` | Request method |
                                    `equals`, `not_equals`, `start_with`,
                                    `not_start_with`, `end_with`,
                                    `not_end_with`, `in`, `not_in` |

                                    | `serves_static_resource` | Static resource
                                    | `none` |

                                    | `similar_password_leaked` | Similar
                                    password leak | `none` |

                                    | `ssl_https` | SSL/HTTPS | `none` |

                                    | `uri` | URI | `wildcard`,
                                    `strict_wildcard`, `equals`, `not_equals`,
                                    `contains`, `not_contains`, `matches`,
                                    `not_matches`, `start_with`,
                                    `not_start_with`, `end_with`, `not_end_with`
                                    |

                                    | `uri_full` | URI full | `wildcard`,
                                    `strict_wildcard`, `equals`, `not_equals`,
                                    `contains`, `not_contains`, `matches`,
                                    `not_matches`, `start_with`,
                                    `not_start_with`, `end_with`, `not_end_with`
                                    |

                                    | `uri_path` | URI path | `wildcard`,
                                    `strict_wildcard`, `equals`, `not_equals`,
                                    `contains`, `not_contains`, `matches`,
                                    `not_matches`, `start_with`,
                                    `not_start_with`, `end_with`,
                                    `not_end_with`, `in`, `not_in` |

                                    | `uri_query_string` | URI query string |
                                    `wildcard`, `strict_wildcard`, `equals`,
                                    `not_equals`, `contains`, `not_contains`,
                                    `matches`, `not_matches`, `start_with`,
                                    `not_start_with`, `end_with`, `not_end_with`
                                    |

                                    | `user_agent` | User agent | `wildcard`,
                                    `strict_wildcard`, `equals`, `not_equals`,
                                    `contains`, `not_contains`, `matches`,
                                    `not_matches`, `start_with`,
                                    `not_start_with`, `end_with`, `not_end_with`
                                    |

                                    | `username_and_password_leaked` | Username
                                    and password leak | `none` |

                                    | `username_leaked` | Username | `none` |

                                    | `verified_bot` | Bot verification | `none`
                                    |

                                    | `verified_bot_category` | Verified bot
                                    category | `in`, `not_in`, `equals`,
                                    `not_equals` |

                                    | `waf_attack_score` | WAF attack score |
                                    `equals`, `not_equals`, `greater_than`,
                                    `less_than`, `greater_than_or_equal`,
                                    `less_than_or_equal`, `in`, `not_in` |

                                    | `waf_rce_attack_score` | WAF RCE attack
                                    score | `equals`, `not_equals`,
                                    `greater_than`, `less_than`,
                                    `greater_than_or_equal`,
                                    `less_than_or_equal`, `in`, `not_in` |

                                    | `waf_sqli_attack_score` | WAF SQLi attack
                                    score | `equals`, `not_equals`,
                                    `greater_than`, `less_than`,
                                    `greater_than_or_equal`,
                                    `less_than_or_equal`, `in`, `not_in` |

                                    | `waf_xss_attack_score` | WAF XSS attack
                                    score | `equals`, `not_equals`,
                                    `greater_than`, `less_than`,
                                    `greater_than_or_equal`,
                                    `less_than_or_equal`, `in`, `not_in` |

                                    | `x_forwarded_for` | X-Forwarded-For |
                                    `wildcard`, `strict_wildcard`, `equals`,
                                    `not_equals`, `contains`, `not_contains`,
                                    `matches`, `not_matches`, `start_with`,
                                    `not_start_with`, `end_with`, `not_end_with`
                                    |
                                  enum:
                                    - as_num
                                    - authentication_detected
                                    - body
                                    - body_size
                                    - bot_detection_ids
                                    - bot_score
                                    - client_certificate_verified
                                    - continent
                                    - cookie
                                    - cookie_value
                                    - country
                                    - environment
                                    - header
                                    - hostname
                                    - http_version
                                    - ip_source_address
                                    - ja4_fingerprint
                                    - json_string
                                    - known_bots
                                    - mime_type
                                    - password_leaked
                                    - referer
                                    - request_method
                                    - serves_static_resource
                                    - similar_password_leaked
                                    - ssl_https
                                    - uri
                                    - uri_full
                                    - uri_path
                                    - uri_query_string
                                    - user_agent
                                    - username_and_password_leaked
                                    - username_leaked
                                    - verified_bot
                                    - verified_bot_category
                                    - waf_attack_score
                                    - waf_rce_attack_score
                                    - waf_sqli_attack_score
                                    - waf_xss_attack_score
                                    - x_forwarded_for
                                operator:
                                  type: string
                                  description: >-
                                    How to compare the field.


                                    - `equals`: equals

                                    - `not_equals`: not equals

                                    - `greater_than`: greater than

                                    - `less_than`: less than

                                    - `greater_than_or_equal`: greater than or
                                    equal

                                    - `less_than_or_equal`: less than or equal

                                    - `in`: in

                                    - `not_in`: not in

                                    - `none`: none

                                    - `contains`: contains

                                    - `not_contains`: not contains

                                    - `matches`: matches

                                    - `not_matches`: not matches

                                    - `start_with`: start with

                                    - `not_start_with`: not start with

                                    - `end_with`: end with

                                    - `not_end_with`: not end with

                                    - `wildcard`: wildcard

                                    - `strict_wildcard`: strict wildcard

                                    - `exists`: exists

                                    - `not_exists`: not exists
                                  enum:
                                    - equals
                                    - not_equals
                                    - greater_than
                                    - less_than
                                    - greater_than_or_equal
                                    - less_than_or_equal
                                    - in
                                    - not_in
                                    - none
                                    - contains
                                    - not_contains
                                    - matches
                                    - not_matches
                                    - start_with
                                    - not_start_with
                                    - end_with
                                    - not_end_with
                                    - wildcard
                                    - strict_wildcard
                                    - exists
                                    - not_exists
                                key:
                                  type: string
                                  description: >-
                                    The entry to match for `key_value` and
                                    `key_array` conditions, such as a header
                                    name. Header names must be lowercase.
                                value:
                                  description: >-
                                    The value to compare with: a string, number
                                    or boolean, or a list for `array` and
                                    `key_array` conditions. Fields with options,
                                    such as `environment`, only accept the
                                    values listed by the Get a ruleset endpoint.
                              required:
                                - criteria
                                - field
                                - operator
                            minItems: 1
                        required:
                          - criterias
                      minItems: 1
                  required:
                    - action
                    - criteria_groups
            created_at:
              type:
                - string
                - 'null'
              format: date-time
            updated_at:
              type:
                - string
                - 'null'
              format: date-time
          required:
            - type
            - name
            - description
            - is_active
            - settings
            - created_at
            - updated_at
      required:
        - id
        - type
      title: EdgeNetworkRuleResource
  responses:
    AuthorizationException:
      description: Authorization error
      content:
        application/json:
          schema:
            type: object
            properties:
              message:
                type: string
                description: Error overview.
            required:
              - message
    ModelNotFoundException:
      description: Not found
      content:
        application/json:
          schema:
            type: object
            properties:
              message:
                type: string
                description: Error overview.
            required:
              - message
  securitySchemes:
    http:
      type: http
      description: The Bearer Token generated on the Cloud UI.
      scheme: bearer
      bearerFormat: bearer

````