- HTTP request
- Path parameters
- Request body
- Response body
- Authorization scopes
- IAM Permissions
- Try it!
Returns effective security policies applied to this backend service.
HTTP request
GET https://compute.googleapis.com/compute/beta/projects/{project}/global/backendServices/{backendService}/getEffectiveSecurityPolicies
The URL uses gRPC Transcoding syntax.
Path parameters
| Parameters | |
|---|---|
project |
Project ID for this request. |
backend |
Name of the Backend Service for this request. |
Request body
The request body must be empty.
Response body
If successful, the response body contains data with the following structure:
| JSON representation |
|---|
{ "securityPolicies": [ { "userDefinedFields": [ { "name": string, "base": enum, "offset": integer, "size": integer, "mask": string } ], "kind": string, "id": string, "creationTimestamp": string, "name": string, "description": string, "rules": [ { "kind": string, "description": string, "priority": integer, "match": { "expr": { "expression": string, "title": string, "description": string, "location": string }, "exprOptions": { "recaptchaOptions": { "actionTokenSiteKeys": [ string ], "sessionTokenSiteKeys": [ string ] } }, "versionedExpr": enum, "config": { "srcIpRanges": [ string ], "destIpRanges": [ string ], "layer4Configs": [ { "ipProtocol": string, "ports": [ string ] } ] } }, "networkMatch": { "userDefinedFields": [ { "name": string, "values": [ string ] } ], "srcIpRanges": [ string ], "destIpRanges": [ string ], "ipProtocols": [ string ], "srcPorts": [ string ], "destPorts": [ string ], "srcRegionCodes": [ string ], "srcAsns": [ integer ] }, "action": string, "preview": boolean, "direction": enum, "targetResources": [ string ], "enableLogging": boolean, "ruleTupleCount": integer, "rateLimitOptions": { "rateLimitThreshold": { "count": integer, "intervalSec": integer }, "conformAction": string, "exceedAction": string, "exceedRedirectOptions": { "type": enum, "target": string }, "enforceOnKey": enum, "enforceOnKeyName": string, "enforceOnKeyConfigs": [ { "enforceOnKeyType": enum, "enforceOnKeyName": string } ], "banThreshold": { "count": integer, "intervalSec": integer }, "banDurationSec": integer }, "targetServiceAccounts": [ string ], "ruleNumber": string, "headerAction": { "requestHeadersToAdds": [ { "headerName": string, "headerValue": string } ] }, "redirectOptions": { "type": enum, "target": string }, "preconfiguredWafConfig": { "exclusions": [ { "targetRuleSet": string, "targetRuleIds": [ string ], "requestHeadersToExclude": [ { "val": string, "op": enum } ], "requestCookiesToExclude": [ { "val": string, "op": enum } ], "requestQueryParamsToExclude": [ { "val": string, "op": enum } ], "requestUrisToExclude": [ { "val": string, "op": enum } ] } ] } } ], "adaptiveProtectionConfig": { "layer7DdosDefenseConfig": { "enable": boolean, "ruleVisibility": enum, "thresholdConfigs": [ { "name": string, "autoDeployLoadThreshold": number, "autoDeployConfidenceThreshold": number, "autoDeployImpactedBaselineThreshold": number, "autoDeployExpirationSec": integer, "detectionLoadThreshold": number, "detectionAbsoluteQps": number, "detectionRelativeToBaselineQps": number, "trafficGranularityConfigs": [ { "type": enum, "value": string, "enableEachUniqueValue": boolean } ] } ] }, "autoDeployConfig": { "loadThreshold": number, "confidenceThreshold": number, "impactedBaselineThreshold": number, "expirationSec": integer } }, "ddosProtectionConfig": { "ddosProtection": enum }, "advancedOptionsConfig": { "jsonParsing": enum, "jsonCustomConfig": { "contentTypes": [ string ] }, "logLevel": enum, "userIpRequestHeaders": [ string ], "requestBodyInspectionSize": string }, "recaptchaOptionsConfig": { "redirectSiteKey": string }, "fingerprint": string, "selfLink": string, "selfLinkWithId": string, "type": enum, "associations": [ { "name": string, "attachmentId": string, "excludedProjects": [ string ], "excludedFolders": [ string ], "securityPolicyId": string, "shortName": string, "displayName": string } ], "labels": { string: string, ... }, "labelFingerprint": string, "ruleTupleCount": integer, "displayName": string, "shortName": string, "parent": string, "region": string } ] } |
| Fields | |
|---|---|
security |
Effective security policies for the backend service. |
security |
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" |
security |
The name of this field. Must be unique within the policy. |
security |
The base relative to which 'offset' is measured. Possible values are:
|
security |
Offset of the first byte of the field (in network byte order) relative to 'base'. |
security |
Size of the field in bytes. Valid values: 1-4. |
security |
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. |
security |
[Output only] Type of the resource. Always |
security |
[Output Only] The unique identifier for the resource. This identifier is defined by the server. |
security |
[Output Only] Creation timestamp in RFC3339 text format. |
security |
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 |
security |
An optional description of this resource. Provide this property when you create the resource. |
security |
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. |
security |
[Output only] Type of the resource. Always |
security |
An optional description of this resource. Provide this property when you create the resource. |
security |
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. |
security |
A match condition that incoming traffic is evaluated against. If it evaluates to true, the corresponding 'action' is enforced. |
security |
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 |
security |
Textual representation of an expression in Common Expression Language syntax. |
security |
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. |
security |
Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. |
security |
Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file. |
security |
The configuration options available when specifying a user defined CEVAL expression (i.e., 'expr'). |
security |
reCAPTCHA configuration options to be applied for the rule. If the rule does not evaluate reCAPTCHA tokens, this field has no effect. |
security |
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. |
security |
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. |
security |
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. |
security |
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. |
security |
CIDR IP address range. Maximum number of srcIpRanges allowed is 10. |
securityPolicies[].rules[].match.config.destIpRanges[] |
CIDR IP address range. This field may only be specified when versionedExpr is set to FIREWALL. |
securityPolicies[].rules[].match.config.layer4Configs[] |
Pairs of IP protocols and ports that the rule should match. This field may only be specified when versionedExpr is set to FIREWALL. |
securityPolicies[].rules[].match.config.layer4Configs[] |
The IP protocol to which this rule applies. The protocol type is required when creating a firewall rule. This value can either be one of the following well known protocol strings ( |
securityPolicies[].rules[].match.config.layer4Configs[] |
An optional list of ports to which this rule applies. This field is only applicable for UDP or TCP protocol. Each entry must be either an integer or a range. If not specified, this rule applies to connections through any port. Example inputs include: This field may only be specified when versionedExpr is set to FIREWALL. |
security |
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. |
security |
User-defined fields. Each element names a defined field and lists the matching values for that field. |
security |
Name of the user-defined field, as given in the definition. |
security |
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"). |
security |
Source IPv4/IPv6 addresses or CIDR prefixes, in standard text format. |
security |
Destination IPv4/IPv6 addresses or CIDR prefixes, in standard text format. |
security |
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". |
security |
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"). |
security |
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"). |
security |
Two-letter ISO 3166-1 alpha-2 country code associated with the source IP address. |
security |
BGP Autonomous System Number associated with the source IP address. |
security |
The Action to perform when the rule is matched. The following are the valid actions:
|
security |
If set to true, the specified action is not enforced. |
securityPolicies[].rules[].direction |
The direction in which this rule applies. This field may only be specified when versionedExpr is set to FIREWALL. |
securityPolicies[].rules[].targetResources[] |
A list of network resource URLs to which this rule applies. This field allows you to control which network's VMs get this rule. If this field is left blank, all VMs within the organization will receive the rule. This field may only be specified when versionedExpr is set to FIREWALL. |
securityPolicies[].rules[].enableLogging |
Denotes whether to enable logging for a particular rule. If logging is enabled, logs will be exported to the configured export destination in Stackdriver. Logs may be exported to BigQuery or Pub/Sub. Note: you cannot enable logging on "goto_next" rules. This field may only be specified when the versionedExpr is set to FIREWALL. |
securityPolicies[].rules[].ruleTupleCount |
[Output Only] Calculation of the complexity of a single firewall security policy rule. |
security |
Must be specified if the action is "rate_based_ban" or "throttle". Cannot be specified for any other actions. |
security |
Threshold at which to begin ratelimiting. |
security |
Number of HTTP(S) requests for calculating the threshold. |
security |
Interval over which the threshold is computed. |
security |
Action to take for requests that are under the configured rate limit threshold. Valid option is "allow" only. |
security |
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 |
security |
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. |
security |
Type of the redirect action. |
security |
Target for the redirect action. This is required if the type is EXTERNAL_302 and cannot be specified for GOOGLE_RECAPTCHA. |
security |
Determines the key to enforce the rateLimitThreshold on. Possible values are:
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. |
security |
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. |
security |
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. |
security |
Determines the key to enforce the rateLimitThreshold on. Possible values are:
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. |
security |
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. |
security |
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'. |
security |
Number of HTTP(S) requests for calculating the threshold. |
security |
Interval over which the threshold is computed. |
security |
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. |
securityPolicies[].rules[].targetServiceAccounts[] |
A list of service accounts indicating the sets of instances that are applied with this rule. |
security |
Identifier for the rule. This is only unique within the given security policy. This can only be set during rule creation, if rule number is not specified it will be generated by the server. |
security |
Optional, additional actions that are performed on headers. This field is only supported in Global Security Policies of type CLOUD_ARMOR. |
security |
The list of request headers to add or overwrite if they're already present. |
security |
The name of the header to set. |
security |
The value to set the named header to. |
security |
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. |
security |
Type of the redirect action. |
security |
Target for the redirect action. This is required if the type is EXTERNAL_302 and cannot be specified for GOOGLE_RECAPTCHA. |
security |
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. |
security |
A list of exclusions to apply during preconfigured WAF evaluation. |
security |
Target WAF rule set to apply the preconfigured WAF exclusion. |
security |
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. |
security |
A list of request header names whose value will be excluded from inspection during preconfigured WAF evaluation. |
security |
The value of the field. |
security |
The match operator for the field. |
security |
A list of request cookie names whose value will be excluded from inspection during preconfigured WAF evaluation. |
security |
The value of the field. |
security |
The match operator for the field. |
security |
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. |
security |
The value of the field. |
security |
The match operator for the field. |
security |
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. |
security |
The value of the field. |
security |
The match operator for the field. |
security |
|
security |
If set to true, enables Cloud Armor Machine Learning. |
security |
If set to true, enables CAAP for L7 DDoS detection. This field is only supported in Global Security Policies of type CLOUD_ARMOR. |
security |
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. |
security |
Configuration options for layer7 adaptive protection for various customizable thresholds. |
security |
The name must be 1-63 characters long, and comply with RFC1035. The name must be unique within the security policy. |
security |
|
security |
|
security |
|
security |
|
security |
|
security |
|
security |
|
security |
Configuration options for enabling Adaptive Protection to operate on specified granular traffic units. |
security |
Type of this configuration. |
security |
Requests that match this value constitute a granular traffic unit. |
security |
If enabled, traffic matching each unique value for the specified type constitutes a separate traffic unit. It can only be set to true if |
security |
|
security |
|
security |
|
security |
|
security |
|
security |
|
security |
|
security |
|
security |
|
security |
Custom configuration to apply the JSON parsing. Only applicable when jsonParsing is set to STANDARD. |
security |
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. |
security |
|
security |
An optional list of case-insensitive request header names to use for resolving the callers client IP address. |
security |
The maximum request size chosen by the customer with Waf enabled. Currently only "8KB" and "128KB" are supported. Values are case insensitive. |
security |
|
security |
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. |
security |
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 To see the latest fingerprint, make A base64-encoded string. |
security |
[Output Only] Server-defined URL for the resource. |
security |
[Output Only] Server-defined URL for this resource with the resource id. |
security |
The type indicates the intended use of the security policy.
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. |
security |
A list of associations that belong to this policy. |
security |
The name for an association. |
security |
The resource that the security policy is attached to. |
security |
A list of projects to exclude from the security policy. |
security |
A list of folders to exclude from the security policy. |
security |
[Output Only] The security policy ID of the association. |
security |
[Output Only] The short name of the security policy of the association. |
securityPolicies[].associations[].displayName |
[Output Only] The display name of the security policy of the association. |
security |
Labels for this resource. These can only be added or modified by the |
security |
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 A base64-encoded string. |
securityPolicies[].ruleTupleCount |
[Output Only] Total count of all security policy rule tuples. A security policy can not exceed a set number of tuples. |
securityPolicies[].displayName |
User-provided name of the organization security policy. The name should be unique in the organization in which the security policy is created. This should only be used when SecurityPolicyType is FIREWALL. The name must be 1-63 characters long, and comply with https://www.ietf.org/rfc/rfc1035.txt. Specifically, the name must be 1-63 characters long and match the regular expression |
security |
User-provided name of the organization security policy. The name should be unique in the organization in which the security policy is created. This should only be used when SecurityPolicyType is CLOUD_ARMOR. The name must be 1-63 characters long, and comply with https://www.ietf.org/rfc/rfc1035.txt. Specifically, the name must be 1-63 characters long and match the regular expression |
security |
[Output Only] The parent of the security policy. |
security |
[Output Only] URL of the region where the regional security policy resides. This field is not applicable to global security policies. |
Authorization scopes
Requires one of the following OAuth scopes:
https://www.googleapis.com/auth/compute.readonlyhttps://www.googleapis.com/auth/computehttps://www.googleapis.com/auth/cloud-platform
For more information, see the Authentication Overview.
IAM Permissions
In addition to any permissions specified on the fields above, authorization requires one or more of the following IAM permissions:
compute.backendServices.getEffectiveSecurityPolicies
To find predefined roles that contain those permissions, see Compute Engine IAM Roles.