REST Resource: regionSecurityPolicies

Resource: SecurityPolicy

Represents a Google Cloud Armor security policy resource.

Only external backend services that use load balancers can reference a security policy. For more information, see Google Cloud Armor security policy overview.

JSON representation 
{
  "userDefinedFields": [
    {
      object (UserDefinedField)
    }
  ],
  "kind": string,
  "id": string,
  "creationTimestamp": string,
  "name": string,
  "description": string,
  "rules": [
    {
      object (Rule)
    }
  ],
  "adaptiveProtectionConfig": {
    object (AdaptiveProtectionConfig)
  },
  "ddosProtectionConfig": {
    object (DdosProtectionConfig)
  },
  "advancedOptionsConfig": {
    object (AdvancedOptionsConfig)
  },
  "recaptchaOptionsConfig": {
    object (RecaptchaOptionsConfig)
  },
  "fingerprint": string,
  "selfLink": string,
  "type": enum (SecurityPolicyType),
  "labels": {
    string: string,
    ...
  },
  "labelFingerprint": string,
  "region": string
}
Fields
userDefinedFields[]

object (UserDefinedField)

Definitions of user-defined fields for CLOUD_ARMOR_NETWORK policies. A user-defined field consists of up to 4 bytes extracted from a fixed offset in the packet, relative to the IPv4, IPv6, TCP, or UDP header, with an optional mask to select certain bits. Rules may then specify matching values for these fields.

Example:

userDefinedFields: - name: "ipv4_fragment_offset" base: IPV4 offset: 6 size: 2 mask: "0x1fff"
kind

string

[Output only] Type of the resource. Always

compute#securityPolicy

for security policies
id

string (uint64 format)

[Output Only] The unique identifier for the resource. This identifier is defined by the server.
creationTimestamp

string

[Output Only] Creation timestamp in RFC3339 text format.
name

string

Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
description

string

An optional description of this resource. Provide this property when you create the resource.
rules[]

object (Rule)

A list of rules that belong to this policy. There must always be a default rule which is a rule with priority 2147483647 and match all condition (for the match condition this means match "*" for srcIpRanges and for the networkMatch condition every field must be either match "*" or not set). If no rules are provided when creating a security policy, a default rule with action "allow" will be added.
adaptiveProtectionConfig

object (AdaptiveProtectionConfig)
ddosProtectionConfig

object (DdosProtectionConfig)
advancedOptionsConfig

object (AdvancedOptionsConfig)
recaptchaOptionsConfig

object (RecaptchaOptionsConfig)
fingerprint

string (bytes format)

Specifies a fingerprint for this resource, which is essentially a hash of the metadata's contents and used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update metadata. You must always provide an up-to-date fingerprint hash in order to update or change metadata, otherwise the request will fail with error

412 conditionNotMet

.

To see the latest fingerprint, make

get()

request to the security policy.

A base64-encoded string.
type

enum (SecurityPolicyType)

The type indicates the intended use of the security policy.

  • CLOUD_ARMOR

    : Cloud Armor backend security policies can be configured to filter incoming HTTP requests targeting backend services. They filter requests before they hit the origin servers.

  • CLOUD_ARMOR_EDGE

    : Cloud Armor edge security policies can be configured to filter incoming HTTP requests targeting backend services (including Cloud CDN-enabled) as well as backend buckets (Cloud Storage). They filter requests before the request is served from Google's cache.

  • CLOUD_ARMOR_INTERNAL_SERVICE

    : Cloud Armor internal service policies can be configured to filter HTTP requests targeting services managed by Traffic Director in a service mesh. They filter requests before the request is served from the application.

  • CLOUD_ARMOR_NETWORK

    : Cloud Armor network policies can be configured to filter packets targeting network load balancing resources such as backend services, target pools, target instances, and instances with external IPs. They filter requests before the request is served from the application.

    • This field can be set only at resource creation time.
    labels

    map (key: string, value: string)

    Labels for this resource. These can only be added or modified by the

    setLabels

    method. Each label key/value pair must comply with RFC1035. Label values may be empty.
    labelFingerprint

    string (bytes format)

    A fingerprint for the labels being applied to this security policy, which is essentially a hash of the labels set used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels.

    To see the latest fingerprint, make

    get()

    request to the security policy.

    A base64-encoded string.
    region

    string

    [Output Only] URL of the region where the regional security policy resides. This field is not applicable to global security policies.

    UserDefinedField

    JSON representation 
    {
  "name": string,
  "base": enum (Base),
  "offset": integer,
  "size": integer,
  "mask": string
}
    Fields
    name

    string

    The name of this field. Must be unique within the policy.
    base

    enum (Base)

    The base relative to which 'offset' is measured. Possible values are:

    • IPV4

      : Points to the beginning of the IPv4 header.

    • IPV6

      : Points to the beginning of the IPv6 header.

    • TCP

      : Points to the beginning of the TCP header, skipping over any IPv4 options or IPv6 extension headers. Not present for non-first fragments.

    • UDP

      : Points to the beginning of the UDP header, skipping over any IPv4 options or IPv6 extension headers. Not present for non-first fragments.

    required
    offset

    integer

    Offset of the first byte of the field (in network byte order) relative to 'base'.
    size

    integer

    Size of the field in bytes. Valid values: 1-4.
    mask

    string

    If specified, apply this mask (bitwise AND) to the field to ignore bits before matching. Encoded as a hexadecimal number (starting with "0x"). The last byte of the field (in network byte order) corresponds to the least significant byte of the mask.

    Base

    Enums
    IPV4
    IPV6
    TCP
    UDP

    Rule

    Represents a rule that describes one or more match conditions along with the action to be taken when traffic matches this condition (allow or deny).

    JSON representation 
    {
  "kind": string,
  "description": string,
  "priority": integer,
  "match": {
    object (Matcher)
  },
  "networkMatch": {
    object (NetworkMatcher)
  },
  "action": string,
  "preview": boolean,
  "rateLimitOptions": {
    object (RateLimitOptions)
  },
  "headerAction": {
    object (HttpHeaderAction)
  },
  "redirectOptions": {
    object (RedirectOptions)
  },
  "preconfiguredWafConfig": {
    object (PreconfiguredWafConfig)
  }
}
    Fields
    kind

    string

    [Output only] Type of the resource. Always

    compute#securityPolicyRule

    for security policy rules
    description

    string

    An optional description of this resource. Provide this property when you create the resource.
    priority

    integer

    An integer indicating the priority of a rule in the list. The priority must be a positive value between 0 and 2147483647. Rules are evaluated from highest to lowest priority where 0 is the highest priority and 2147483647 is the lowest priority.
    match

    object (Matcher)

    A match condition that incoming traffic is evaluated against. If it evaluates to true, the corresponding 'action' is enforced.
    networkMatch

    object (NetworkMatcher)

    A match condition that incoming packets are evaluated against for CLOUD_ARMOR_NETWORK security policies. If it matches, the corresponding 'action' is enforced.

    The match criteria for a rule consists of built-in match fields (like 'srcIpRanges') and potentially multiple user-defined match fields ('userDefinedFields').

    Field values may be extracted directly from the packet or derived from it (e.g. 'srcRegionCodes'). Some fields may not be present in every packet (e.g. 'srcPorts'). A user-defined field is only present if the base header is found in the packet and the entire field is in bounds.

    Each match field may specify which values can match it, listing one or more ranges, prefixes, or exact values that are considered a match for the field. A field value must be present in order to match a specified match field. If no match values are specified for a match field, then any field value is considered to match it, and it's not required to be present. For strings specifying '*' is also equivalent to match all.

    For a packet to match a rule, all specified match fields must match the corresponding field values derived from the packet.

    Example:

    networkMatch: srcIpRanges: - "192.0.2.0/24" - "198.51.100.0/24" userDefinedFields: - name: "ipv4_fragment_offset" values: - "1-0x1fff"

    The above match condition matches packets with a source IP in 192.0.2.0/24 or 198.51.100.0/24 and a user-defined field named "ipv4_fragment_offset" with a value between 1 and 0x1fff inclusive.
    action

    string

    The Action to perform when the rule is matched. The following are the valid actions:

    • allow

      : allow access to target.

    • deny(STATUS)

      : deny access to target, returns the HTTP response code specified. Valid values for STATUS are 403, 404, and 502.

    • rate_based_ban

      : limit client traffic to the configured threshold and ban the client if the traffic exceeds the threshold. Configure parameters for this action in RateLimitOptions. Requires rateLimitOptions to be set.

    • redirect

      : redirect to a different target. This can either be an internal reCAPTCHA redirect, or an external URL-based redirect via a 302 response. Parameters for this action can be configured via redirectOptions. This action is only supported in Global Security Policies of type CLOUD_ARMOR.

    • throttle

      : limit client traffic to the configured threshold. Configure parameters for this action in rateLimitOptions. Requires rateLimitOptions to be set for this.
    preview

    boolean

    If set to true, the specified action is not enforced.
    rateLimitOptions

    object (RateLimitOptions)

    Must be specified if the action is "rate_based_ban" or "throttle". Cannot be specified for any other actions.
    headerAction

    object (HttpHeaderAction)

    Optional, additional actions that are performed on headers. This field is only supported in Global Security Policies of type CLOUD_ARMOR.
    redirectOptions

    object (RedirectOptions)

    Parameters defining the redirect action. Cannot be specified for any other actions. This field is only supported in Global Security Policies of type CLOUD_ARMOR.
    preconfiguredWafConfig

    object (PreconfiguredWafConfig)

    Preconfigured WAF configuration to be applied for the rule. If the rule does not evaluate preconfigured WAF rules, i.e., if evaluatePreconfiguredWaf() is not used, this field will have no effect.

    Matcher

    Represents a match condition that incoming traffic is evaluated against. Exactly one field must be specified.

    JSON representation 
    {
  "expr": {
    object (Expr)
  },
  "exprOptions": {
    object (ExprOptions)
  },
  "versionedExpr": enum (VersionedExpr),
  "config": {
    object (Config)
  }
}
    Fields
    expr

    object (Expr)

    User defined CEVAL expression. A CEVAL expression is used to specify match criteria such as origin.ip, source.region_code and contents in the request header. Expressions containing evaluateThreatIntelligence require Cloud Armor Managed Protection Plus tier and are not supported in Edge Policies nor in Regional Policies. Expressions containing evaluatePreconfiguredExpr('sourceiplist-*') require Cloud Armor Managed Protection Plus tier and are only supported in Global Security Policies.
    exprOptions

    object (ExprOptions)

    The configuration options available when specifying a user defined CEVAL expression (i.e., 'expr').
    versionedExpr

    enum (VersionedExpr)

    Preconfigured versioned expression. If this field is specified, config must also be specified. Available preconfigured expressions along with their requirements are: SRC_IPS_V1 - must specify the corresponding srcIpRange field in config.
    config

    object (Config)

    The configuration options available when specifying versionedExpr. This field must be specified if versionedExpr is specified and cannot be specified if versionedExpr is not specified.

    Expr

    Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec.

    Example (Comparison):

    title: "Summary size limit"
description: "Determines if a summary is less than 100 chars"
expression: "document.summary.size() < 100"

    Example (Equality):

    title: "Requestor is owner"
description: "Determines if requestor is the document owner"
expression: "document.owner == request.auth.claims.email"

    Example (Logic):

    title: "Public documents"
description: "Determine whether the document should be publicly visible"
expression: "document.type != 'private' && document.type != 'internal'"

    Example (Data Manipulation):

    title: "Notification string"
description: "Create a notification string with a timestamp."
expression: "'New message received at ' + string(document.create_time)"

    The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information.

    JSON representation 
    {
  "expression": string,
  "title": string,
  "description": string,
  "location": string
}
    Fields
    expression

    string

    Textual representation of an expression in Common Expression Language syntax.
    title

    string

    Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression.
    description

    string

    Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI.
    location

    string

    Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file.

    ExprOptions

    JSON representation 
    {
  "recaptchaOptions": {
    object (RecaptchaOptions)
  }
}
    Fields
    recaptchaOptions

    object (RecaptchaOptions)

    reCAPTCHA configuration options to be applied for the rule. If the rule does not evaluate reCAPTCHA tokens, this field has no effect.

    RecaptchaOptions

    JSON representation 
    {
  "actionTokenSiteKeys": [
    string
  ],
  "sessionTokenSiteKeys": [
    string
  ]
}
    Fields
    actionTokenSiteKeys[]

    string

    A list of site keys to be used during the validation of reCAPTCHA action-tokens. The provided site keys need to be created from reCAPTCHA API under the same project where the security policy is created.
    sessionTokenSiteKeys[]

    string

    A list of site keys to be used during the validation of reCAPTCHA session-tokens. The provided site keys need to be created from reCAPTCHA API under the same project where the security policy is created.

    VersionedExpr

    Enums
    SRC_IPS_V1 Matches the source IP address of a request to the IP ranges supplied in config.

    Config

    JSON representation 
    {
  "srcIpRanges": [
    string
  ]
}
    Fields
    srcIpRanges[]

    string

    CIDR IP address range. Maximum number of srcIpRanges allowed is 10.

    NetworkMatcher

    Represents a match condition that incoming network traffic is evaluated against.

    JSON representation 
    {
  "userDefinedFields": [
    {
      object (UserDefinedFieldMatch)
    }
  ],
  "srcIpRanges": [
    string
  ],
  "destIpRanges": [
    string
  ],
  "ipProtocols": [
    string
  ],
  "srcPorts": [
    string
  ],
  "destPorts": [
    string
  ],
  "srcRegionCodes": [
    string
  ],
  "srcAsns": [
    integer
  ]
}
    Fields
    userDefinedFields[]

    object (UserDefinedFieldMatch)

    User-defined fields. Each element names a defined field and lists the matching values for that field.
    srcIpRanges[]

    string

    Source IPv4/IPv6 addresses or CIDR prefixes, in standard text format.
    destIpRanges[]

    string

    Destination IPv4/IPv6 addresses or CIDR prefixes, in standard text format.
    ipProtocols[]

    string

    IPv4 protocol / IPv6 next header (after extension headers). Each element can be an 8-bit unsigned decimal number (e.g. "6"), range (e.g. "253-254"), or one of the following protocol names: "tcp", "udp", "icmp", "esp", "ah", "ipip", or "sctp".
    srcPorts[]

    string

    Source port numbers for TCP/UDP/SCTP. Each element can be a 16-bit unsigned decimal number (e.g. "80") or range (e.g. "0-1023").
    destPorts[]

    string

    Destination port numbers for TCP/UDP/SCTP. Each element can be a 16-bit unsigned decimal number (e.g. "80") or range (e.g. "0-1023").
    srcRegionCodes[]

    string

    Two-letter ISO 3166-1 alpha-2 country code associated with the source IP address.
    srcAsns[]

    integer (uint32 format)

    BGP Autonomous System Number associated with the source IP address.

    UserDefinedFieldMatch

    JSON representation 
    {
  "name": string,
  "values": [
    string
  ]
}
    Fields
    name

    string

    Name of the user-defined field, as given in the definition.
    values[]

    string

    Matching values of the field. Each element can be a 32-bit unsigned decimal or hexadecimal (starting with "0x") number (e.g. "64") or range (e.g. "0x400-0x7ff").

    RateLimitOptions

    JSON representation 
    {
  "rateLimitThreshold": {
    object (Threshold)
  },
  "conformAction": string,
  "exceedAction": string,
  "exceedRedirectOptions": {
    object (RedirectOptions)
  },
  "enforceOnKey": enum (EnforceOnKey),
  "enforceOnKeyName": string,
  "enforceOnKeyConfigs": [
    {
      object (EnforceOnKeyConfig)
    }
  ],
  "banThreshold": {
    object (Threshold)
  },
  "banDurationSec": integer
}
    Fields
    rateLimitThreshold

    object (Threshold)

    Threshold at which to begin ratelimiting.
    conformAction

    string

    Action to take for requests that are under the configured rate limit threshold. Valid option is "allow" only.
    exceedAction

    string

    Action to take for requests that are above the configured rate limit threshold, to either deny with a specified HTTP response code, or redirect to a different endpoint. Valid options are deny(STATUS), where valid values for STATUS are 403, 404, 429, and 502, and redirect, where the redirect parameters come from exceedRedirectOptions below. The redirect action is only supported in Global Security Policies of type CLOUD_ARMOR.
    exceedRedirectOptions

    object (RedirectOptions)

    Parameters defining the redirect action that is used as the exceed action. Cannot be specified if the exceed action is not redirect. This field is only supported in Global Security Policies of type CLOUD_ARMOR.
    enforceOnKey

    enum (EnforceOnKey)

    Determines the key to enforce the rateLimitThreshold on. Possible values are:

    • ALL

      : A single rate limit threshold is applied to all the requests matching this rule. This is the default value if "enforceOnKey" is not configured.

    • IP

      : The source IP address of the request is the key. Each IP has this limit enforced separately.

    • HTTP_HEADER

      : The value of the HTTP header whose name is configured under "enforceOnKeyName". The key value is truncated to the first 128 bytes of the header value. If no such header is present in the request, the key type defaults to

      ALL

      .

    • XFF_IP

      : The first IP address (i.e. the originating client IP address) specified in the list of IPs under X-Forwarded-For HTTP header. If no such header is present or the value is not a valid IP, the key defaults to the source IP address of the request i.e. key type

      IP

      .

    • HTTP_COOKIE

      : The value of the HTTP cookie whose name is configured under "enforceOnKeyName". The key value is truncated to the first 128 bytes of the cookie value. If no such cookie is present in the request, the key type defaults to

      ALL

      .

    • HTTP_PATH

      : The URL path of the HTTP request. The key value is truncated to the first 128 bytes.

    • SNI

      : Server name indication in the TLS session of the HTTPS request. The key value is truncated to the first 128 bytes. The key type defaults to

      ALL

      on a HTTP session.

    • REGION_CODE

      : The country/region from which the request originates.

    • TLS_JA3_FINGERPRINT

      : JA3 TLS/SSL fingerprint if the client connects using HTTPS, HTTP/2 or HTTP/3. If not available, the key type defaults to

      ALL

      .

    • USER_IP

      : The IP address of the originating client, which is resolved based on "userIpRequestHeaders" configured with the security policy. If there is no "userIpRequestHeaders" configuration or an IP address cannot be resolved from it, the key type defaults to

      IP

      .

  • TLS_JA4_FINGERPRINT

    : JA4 TLS/SSL fingerprint if the client connects using HTTPS, HTTP/2 or HTTP/3. If not available, the key type defaults to

    ALL

    .

    • enforceOnKeyName

    string

    Rate limit key name applicable only for the following key types: HTTP_HEADER -- Name of the HTTP header whose value is taken as the key value. HTTP_COOKIE -- Name of the HTTP cookie whose value is taken as the key value.
    enforceOnKeyConfigs[]

    object (EnforceOnKeyConfig)

    If specified, any combination of values of enforceOnKeyType/enforceOnKeyName is treated as the key on which ratelimit threshold/action is enforced. You can specify up to 3 enforceOnKeyConfigs. If enforceOnKeyConfigs is specified, enforceOnKey must not be specified.
    banThreshold

    object (Threshold)

    Can only be specified if the action for the rule is "rate_based_ban". If specified, the key will be banned for the configured 'banDurationSec' when the number of requests that exceed the 'rateLimitThreshold' also exceed this 'banThreshold'.
    banDurationSec

    integer

    Can only be specified if the action for the rule is "rate_based_ban". If specified, determines the time (in seconds) the traffic will continue to be banned by the rate limit after the rate falls below the threshold.

    Threshold

    JSON representation 
    {
  "count": integer,
  "intervalSec": integer
}
    Fields
    count

    integer

    Number of HTTP(S) requests for calculating the threshold.
    intervalSec

    integer

    Interval over which the threshold is computed.

    RedirectOptions

    JSON representation 
    {
  "type": enum (RedirectType),
  "target": string
}
    Fields
    type

    enum (RedirectType)

    Type of the redirect action.
    target

    string

    Target for the redirect action. This is required if the type is EXTERNAL_302 and cannot be specified for GOOGLE_RECAPTCHA.

    RedirectType

    Enums
    GOOGLE_RECAPTCHA
    EXTERNAL_302

    EnforceOnKey

    Enums
    IP
    ALL
    HTTP_HEADER
    XFF_IP
    HTTP_PATH
    SNI
    REGION_CODE
    TLS_JA3_FINGERPRINT
    USER_IP
    TLS_JA4_FINGERPRINT

    EnforceOnKeyConfig

    JSON representation 
    {
  "enforceOnKeyType": enum (EnforceOnKey),
  "enforceOnKeyName": string
}
    Fields
    enforceOnKeyType

    enum (EnforceOnKey)

    Determines the key to enforce the rateLimitThreshold on. Possible values are:

    • ALL

      : A single rate limit threshold is applied to all the requests matching this rule. This is the default value if "enforceOnKeyConfigs" is not configured.

    • IP

      : The source IP address of the request is the key. Each IP has this limit enforced separately.

    • HTTP_HEADER

      : The value of the HTTP header whose name is configured under "enforceOnKeyName". The key value is truncated to the first 128 bytes of the header value. If no such header is present in the request, the key type defaults to

      ALL

      .

    • XFF_IP

      : The first IP address (i.e. the originating client IP address) specified in the list of IPs under X-Forwarded-For HTTP header. If no such header is present or the value is not a valid IP, the key defaults to the source IP address of the request i.e. key type

      IP

      .

    • HTTP_COOKIE

      : The value of the HTTP cookie whose name is configured under "enforceOnKeyName". The key value is truncated to the first 128 bytes of the cookie value. If no such cookie is present in the request, the key type defaults to

      ALL

      .

    • HTTP_PATH

      : The URL path of the HTTP request. The key value is truncated to the first 128 bytes.

    • SNI

      : Server name indication in the TLS session of the HTTPS request. The key value is truncated to the first 128 bytes. The key type defaults to

      ALL

      on a HTTP session.

    • REGION_CODE

      : The country/region from which the request originates.

    • TLS_JA3_FINGERPRINT

      : JA3 TLS/SSL fingerprint if the client connects using HTTPS, HTTP/2 or HTTP/3. If not available, the key type defaults to

      ALL

      .

    • USER_IP

      : The IP address of the originating client, which is resolved based on "userIpRequestHeaders" configured with the security policy. If there is no "userIpRequestHeaders" configuration or an IP address cannot be resolved from it, the key type defaults to

      IP

      .

  • TLS_JA4_FINGERPRINT

    : JA4 TLS/SSL fingerprint if the client connects using HTTPS, HTTP/2 or HTTP/3. If not available, the key type defaults to

    ALL

    .

    • enforceOnKeyName

    string

    Rate limit key name applicable only for the following key types: HTTP_HEADER -- Name of the HTTP header whose value is taken as the key value. HTTP_COOKIE -- Name of the HTTP cookie whose value is taken as the key value.

    HttpHeaderAction

    JSON representation 
    {
  "requestHeadersToAdds": [
    {
      object (HttpHeaderOption)
    }
  ]
}
    Fields
    requestHeadersToAdds[]

    object (HttpHeaderOption)

    The list of request headers to add or overwrite if they're already present.

    HttpHeaderOption

    JSON representation 
    {
  "headerName": string,
  "headerValue": string
}
    Fields
    headerName

    string

    The name of the header to set.
    headerValue

    string

    The value to set the named header to.

    PreconfiguredWafConfig

    JSON representation 
    {
  "exclusions": [
    {
      object (Exclusion)
    }
  ]
}
    Fields
    exclusions[]

    object (Exclusion)

    A list of exclusions to apply during preconfigured WAF evaluation.

    Exclusion

    JSON representation 
    {
  "targetRuleSet": string,
  "targetRuleIds": [
    string
  ],
  "requestHeadersToExclude": [
    {
      object (FieldParams)
    }
  ],
  "requestCookiesToExclude": [
    {
      object (FieldParams)
    }
  ],
  "requestQueryParamsToExclude": [
    {
      object (FieldParams)
    }
  ],
  "requestUrisToExclude": [
    {
      object (FieldParams)
    }
  ]
}
    Fields
    targetRuleSet

    string

    Target WAF rule set to apply the preconfigured WAF exclusion.
    targetRuleIds[]

    string

    A list of target rule IDs under the WAF rule set to apply the preconfigured WAF exclusion. If omitted, it refers to all the rule IDs under the WAF rule set.
    requestHeadersToExclude[]

    object (FieldParams)

    A list of request header names whose value will be excluded from inspection during preconfigured WAF evaluation.
    requestQueryParamsToExclude[]

    object (FieldParams)

    A list of request query parameter names whose value will be excluded from inspection during preconfigured WAF evaluation. Note that the parameter can be in the query string or in the POST body.
    requestUrisToExclude[]

    object (FieldParams)

    A list of request URIs from the request line to be excluded from inspection during preconfigured WAF evaluation. When specifying this field, the query or fragment part should be excluded.

    FieldParams

    JSON representation 
    {
  "val": string,
  "op": enum (FieldOp)
}
    Fields
    val

    string

    The value of the field.
    op

    enum (FieldOp)

    The match operator for the field.

    FieldOp

    Enums
    EQUALS The operator matches if the field value equals the specified value.
    STARTS_WITH The operator matches if the field value starts with the specified value.
    ENDS_WITH The operator matches if the field value ends with the specified value.
    CONTAINS The operator matches if the field value contains the specified value.
    EQUALS_ANY The operator matches if the field value is any value.

    AdaptiveProtectionConfig

    Configuration options for Cloud Armor Adaptive Protection (CAAP).

    JSON representation 
    {
  "layer7DdosDefenseConfig": {
    object (Layer7DdosDefenseConfig)
  }
}
    Fields
    layer7DdosDefenseConfig

    object (Layer7DdosDefenseConfig)

    If set to true, enables Cloud Armor Machine Learning.

    Layer7DdosDefenseConfig

    Configuration options for L7 DDoS detection. This field is only supported in Global Security Policies of type CLOUD_ARMOR.

    JSON representation 
    {
  "enable": boolean,
  "ruleVisibility": enum (RuleVisibility),
  "thresholdConfigs": [
    {
      object (ThresholdConfig)
    }
  ]
}
    Fields
    enable

    boolean

    If set to true, enables CAAP for L7 DDoS detection. This field is only supported in Global Security Policies of type CLOUD_ARMOR.
    ruleVisibility

    enum (RuleVisibility)

    Rule visibility can be one of the following: STANDARD - opaque rules. (default) PREMIUM - transparent rules. This field is only supported in Global Security Policies of type CLOUD_ARMOR.
    thresholdConfigs[]

    object (ThresholdConfig)

    Configuration options for layer7 adaptive protection for various customizable thresholds.

    RuleVisibility

    Enums
    STANDARD
    PREMIUM

    ThresholdConfig

    JSON representation 
    {
  "name": string,
  "autoDeployLoadThreshold": number,
  "autoDeployConfidenceThreshold": number,
  "autoDeployImpactedBaselineThreshold": number,
  "autoDeployExpirationSec": integer,
  "detectionLoadThreshold": number,
  "detectionAbsoluteQps": number,
  "detectionRelativeToBaselineQps": number,
  "trafficGranularityConfigs": [
    {
      object (TrafficGranularityConfig)
    }
  ]
}
    Fields
    name

    string

    The name must be 1-63 characters long, and comply with RFC1035. The name must be unique within the security policy.
    autoDeployLoadThreshold

    number
    autoDeployConfidenceThreshold

    number
    autoDeployImpactedBaselineThreshold

    number
    autoDeployExpirationSec

    integer
    detectionLoadThreshold

    number
    detectionAbsoluteQps

    number
    detectionRelativeToBaselineQps

    number
    trafficGranularityConfigs[]

    object (TrafficGranularityConfig)

    Configuration options for enabling Adaptive Protection to operate on specified granular traffic units.

    TrafficGranularityConfig

    Configurations to specifc granular traffic units processed by Adaptive Protection.

    JSON representation 
    {
  "type": enum (Type),
  "value": string,
  "enableEachUniqueValue": boolean
}
    Fields
    type

    enum (Type)

    Type of this configuration.
    value

    string

    Requests that match this value constitute a granular traffic unit.
    enableEachUniqueValue

    boolean

    If enabled, traffic matching each unique value for the specified type constitutes a separate traffic unit. It can only be set to true if value is empty.

    Type

    Types on which a granular unit can be configured.

    Enums
    UNSPECIFIED_TYPE
    HTTP_HEADER_HOST
    HTTP_PATH

    DdosProtectionConfig

    JSON representation 
    {
  "ddosProtection": enum (DdosProtection)
}
    Fields
    ddosProtection

    enum (DdosProtection)

    DdosProtection

    Enums
    STANDARD
    ADVANCED

    AdvancedOptionsConfig

    JSON representation 
    {
  "jsonParsing": enum (JsonParsing),
  "jsonCustomConfig": {
    object (JsonCustomConfig)
  },
  "logLevel": enum (LogLevel),
  "userIpRequestHeaders": [
    string
  ]
}
    Fields
    jsonParsing

    enum (JsonParsing)
    jsonCustomConfig

    object (JsonCustomConfig)

    Custom configuration to apply the JSON parsing. Only applicable when jsonParsing is set to STANDARD.
    logLevel

    enum (LogLevel)
    userIpRequestHeaders[]

    string

    An optional list of case-insensitive request header names to use for resolving the callers client IP address.

    JsonParsing

    Enums
    DISABLED
    STANDARD
    STANDARD_WITH_GRAPHQL

    JsonCustomConfig

    JSON representation 
    {
  "contentTypes": [
    string
  ]
}
    Fields
    contentTypes[]

    string

    A list of custom Content-Type header values to apply the JSON parsing.

    As per RFC 1341, a Content-Type header value has the following format:

    Content-Type := type "/" subtype *[";" parameter]

    When configuring a custom Content-Type header value, only the type/subtype needs to be specified, and the parameters should be excluded.

    LogLevel

    Enums
    NORMAL
    VERBOSE

    RecaptchaOptionsConfig

    JSON representation 
    {
  "redirectSiteKey": string
}
    Fields
    redirectSiteKey

    string

    An optional field to supply a reCAPTCHA site key to be used for all the rules using the redirect action with the type of GOOGLE_RECAPTCHA under the security policy. The specified site key needs to be created from the reCAPTCHA API. The user is responsible for the validity of the specified site key. If not specified, a Google-managed site key is used. This field is only supported in Global Security Policies of type CLOUD_ARMOR.

    SecurityPolicyType

    Enums
    CLOUD_ARMOR
    CLOUD_ARMOR_EDGE
    CLOUD_ARMOR_NETWORK

    Methods

    addRule

    		 The method compute.v1.RegionSecurityPoliciesService.AddRule is not available in this (s3nsapis.fr) universe.

    delete

    		 The method compute.v1.RegionSecurityPoliciesService.Delete is not available in this (s3nsapis.fr) universe.

    get

    		 The method compute.v1.RegionSecurityPoliciesService.Get is not available in this (s3nsapis.fr) universe.

    getRule

    		 The method compute.v1.RegionSecurityPoliciesService.GetRule is not available in this (s3nsapis.fr) universe.

    insert

    		 The method compute.v1.RegionSecurityPoliciesService.Insert is not available in this (s3nsapis.fr) universe.

    list

    		 The method compute.v1.RegionSecurityPoliciesService.List is not available in this (s3nsapis.fr) universe.

    patch

    		 The method compute.v1.RegionSecurityPoliciesService.Patch is not available in this (s3nsapis.fr) universe.

    patchRule

    		 The method compute.v1.RegionSecurityPoliciesService.PatchRule is not available in this (s3nsapis.fr) universe.

    removeRule

    		 The method compute.v1.RegionSecurityPoliciesService.RemoveRule is not available in this (s3nsapis.fr) universe.

    setLabels

    		 The method compute.v1.RegionSecurityPoliciesService.SetLabels is not available in this (s3nsapis.fr) universe.