- HTTP request
- Path parameters
- Query parameters
- Request body
- Response body
- Authorization scopes
- IAM Permissions
- Try it!
Updates the specified firewall rule with the data included in the request. Note that all fields will be updated if using PUT, even fields that are not specified. To update individual fields, please use PATCH instead.
HTTP request
PUT https://compute.googleapis.com/compute/v1/projects/{project}/global/firewalls/{firewall}
The URL uses gRPC Transcoding syntax.
Path parameters
Parameters | |
---|---|
project
|
Project ID for this request. |
firewall
|
Name of the firewall rule to update. |
Query parameters
Parameters | |
---|---|
requestId
|
An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID
with the exception that zero UUID is not supported ( |
Request body
The request body contains data with the following structure:
JSON representation |
---|
{ "kind" : string , "id" : string , "creationTimestamp" : string , "name" : string , "description" : string , "network" : string , "priority" : integer , "sourceRanges" : [ string ] , "destinationRanges" : [ string ] , "sourceTags" : [ string ] , "targetTags" : [ string ] , "sourceServiceAccounts" : [ string ] , "targetServiceAccounts" : [ string ] , "allowed" : [ { "IPProtocol" : string , "ports" : [ string ] } ] , "denied" : [ { "IPProtocol" : string , "ports" : [ string ] } ] , "direction" : enum , "logConfig" : { "enable" : boolean , "metadata" : enum } , "disabled" : boolean , "selfLink" : string } |
kind
string
[Output Only] Type of the resource. Always compute#firewall
for firewall rules.
id
string ( uint64
format)
[Output Only] The unique identifier for the resource. This identifier is defined by the server.
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])?
. The first character must be a lowercase letter, and all following characters (except for the last character) must be a dash, lowercase letter, or digit. The last character must be a lowercase letter or digit.
description
string
An optional description of this resource. Provide this field when you create the resource.
network
string
URL of the network resource for this firewall rule. If not specified when creating a firewall rule, the default
network is used:
global/networks/defaultIf you choose to specify this field, you can specify the network as a full or partial URL. For example, the following are all valid URLs:
-
https://www.googleapis.com/compute/v1/projects/myproject/global/networks/my-network
-
projects/myproject/global/networks/my-network
-
global/networks/default
Authorization requires the following IAM
permission on the specified resource network
:
-
compute.networks.updatePolicy
priority
integer
Priority for this rule. This is an integer between 0
and 65535
, both inclusive. The default value is 1000
. Relative priorities determine which rule takes effect if multiple rules apply. Lower values indicate higher priority. For example, a rule with priority 0
has higher precedence than a rule with priority 1
. DENY rules take precedence over ALLOW rules if they have equal priority. Note that VPC networks have implied
rules with a priority of 65535
. To avoid conflicts with the implied rules, use a priority number less than 65535
.
sourceRanges[]
string
If source ranges are specified, the firewall rule applies only to traffic that has a source IP address in these ranges. These ranges must be expressed in CIDR
format. One or both of sourceRanges
and sourceTags
may be set. If both fields are set, the rule applies to traffic that has a source IP address within sourceRanges
OR a source IP from a resource with a matching tag listed in the sourceTags
field. The connection does not need to match both fields for the rule to apply. Both IPv4 and IPv6 are supported.
destinationRanges[]
string
If destination ranges are specified, the firewall rule applies only to traffic that has destination IP address in these ranges. These ranges must be expressed in CIDR format. Both IPv4 and IPv6 are supported.
sourceTags[]
string
If source tags are specified, the firewall rule applies only to traffic with source IPs that match the primary network interfaces of VM instances that have the tag and are in the same VPC network. Source tags cannot be used to control traffic to an instance's external IP address, it only applies to traffic between instances in the same virtual network. Because tags are associated with instances, not IP addresses. One or both of sourceRanges
and sourceTags
may be set. If both fields are set, the firewall applies to traffic that has a source IP address within sourceRanges
OR a source IP from a resource with a matching tag listed in the sourceTags
field. The connection does not need to match both fields for the firewall to apply.
targetTags[]
string
A list of tags that controls which instances the firewall rule applies to. If targetTags
are specified, then the firewall rule applies only to instances in the VPC network that have one of those tags. If no targetTags
are specified, the firewall rule applies to all instances on the specified network.
sourceServiceAccounts[]
string
If source service accounts are specified, the firewall rules apply only to traffic originating from an instance with a service account in this list. Source service accounts cannot be used to control traffic to an instance's external IP address because service accounts are associated with an instance, not an IP address. sourceRanges
can be set at the same time as sourceServiceAccounts
. If both are set, the firewall applies to traffic that has a source IP address within the sourceRanges
OR a source IP that belongs to an instance with service account listed in sourceServiceAccount
. The connection does not need to match both fields for the firewall to apply. sourceServiceAccounts
cannot be used at the same time as sourceTags
or targetTags
.
targetServiceAccounts[]
string
A list of service accounts indicating sets of instances located in the network that may make network connections as specified in allowed[]
. targetServiceAccounts
cannot be used at the same time as targetTags
or sourceTags
. If neither targetServiceAccounts
nor targetTags
are specified, the firewall rule applies to all instances on the specified network.
allowed[]
object
The list of ALLOW rules specified by this firewall. Each rule specifies a protocol and port-range tuple that describes a permitted connection.
allowed[].IPProtocol
string
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 ( tcp
, udp
, icmp
, esp
, ah
, ipip
, sctp
) or the IP protocol number.
allowed[].ports[]
string
An optional list of ports to which this rule applies. This field is only applicable for the 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: ["22"]
, ["80","443"]
, and ["12345-12349"]
.
denied[]
object
The list of DENY rules specified by this firewall. Each rule specifies a protocol and port-range tuple that describes a denied connection.
denied[].IPProtocol
string
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 ( tcp
, udp
, icmp
, esp
, ah
, ipip
, sctp
) or the IP protocol number.
denied[].ports[]
string
An optional list of ports to which this rule applies. This field is only applicable for the 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: ["22"]
, ["80","443"]
, and ["12345-12349"]
.
direction
enum
Direction of traffic to which this firewall applies, either INGRESS
or EGRESS
. The default is INGRESS
. For EGRESS
traffic, you cannot specify the sourceTags
fields.
logConfig
object
This field denotes the logging options for a particular firewall rule. If logging is enabled, logs will be exported to Cloud Logging.
logConfig.enable
boolean
This field denotes whether to enable logging for a particular firewall rule.
logConfig.metadata
enum
This field can only be specified for a particular firewall rule if logging is enabled for that rule. This field denotes whether to include or exclude metadata for firewall logs.
disabled
boolean
Denotes whether the firewall rule is disabled. When set to true, the firewall rule is not enforced and the network behaves as if it did not exist. If this is unspecified, the firewall rule will be enabled.
selfLink
string
[Output Only] Server-defined URL for the resource.
Response body
Represents an Operation resource.
Google Compute Engine has three Operation resources:
You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses .
Operations can be global, regional or zonal.
- For global operations, use the
globalOperations
resource. - For regional operations, use the
regionOperations
resource. - For zonal operations, use the
zoneOperations
resource.
For more information, read Global, Regional, and Zonal Resources .
Note that completed Operation resources have a limited retention period.
If successful, the response body contains data with the following structure:
JSON representation |
---|
{ "kind" : string , "id" : string , "creationTimestamp" : string , "name" : string , "zone" : string , "clientOperationId" : string , "operationType" : string , "targetLink" : string , "targetId" : string , "status" : enum , "statusMessage" : string , "user" : string , "progress" : integer , "insertTime" : string , "startTime" : string , "endTime" : string , "error" : { "errors" : [ { "code" : string , "location" : string , "message" : string , "errorDetails" : [ { "errorInfo" : { "reason" : string , "domain" : string , "metadatas" : { string : string , ... } } , "quotaInfo" : { "metricName" : string , "limitName" : string , "dimensions" : { string : string , ... } , "limit" : number , "futureLimit" : number , "rolloutStatus" : enum } , "help" : { "links" : [ { "description" : string , "url" : string } ] } , "localizedMessage" : { "locale" : string , "message" : string } } ] } ] } , "warnings" : [ { "code" : enum , "message" : string , "data" : [ { "key" : string , "value" : string } ] } ] , "httpErrorStatusCode" : integer , "httpErrorMessage" : string , "selfLink" : string , "region" : string , "description" : string , "operationGroupId" : string , // Union field |
kind
string
[Output Only] Type of the resource. Always compute#operation
for Operation resources.
id
string ( uint64
format)
[Output Only] The unique identifier for the operation. This identifier is defined by the server.
name
string
[Output Only] Name of the operation.
zone
string
[Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.
clientOperationId
string
[Output Only] The value of requestId
if you provided it in the request. Not present otherwise.
operationType
string
[Output Only] The type of operation, such as insert
, update
, or delete
, and so on.
targetLink
string
[Output Only] The URL of the resource that the operation modifies. For operations related to creating a snapshot, this points to the persistent disk that the snapshot was created from.
targetId
string ( uint64
format)
[Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
status
enum
[Output Only] The status of the operation, which can be one of the following: PENDING
, RUNNING
, or DONE
.
user
string
[Output Only] User who requested the operation, for example: user@example.com
or alice_smith_identifier (global/workforcePools/example-com-us-employees)
.
progress
integer
[Output Only] An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess when the operation will be complete. This number should monotonically increase as the operation progresses.
startTime
string
[Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
endTime
string
[Output Only] The time that this operation was completed. This value is in RFC3339 text format.
error
object
[Output Only] If errors are generated during processing of the operation, this field will be populated.
error.errors[]
object
[Output Only] The array of errors encountered while processing this operation.
error.errors[].code
string
[Output Only] The error type identifier for this error.
error.errors[].location
string
[Output Only] Indicates the field in the request that caused the error. This property is optional.
error.errors[].message
string
[Output Only] An optional, human-readable error message.
error.errors[].errorDetails[]
object
[Output Only] An optional list of messages that contain the error details. There is a set of defined message types to use for providing details.The syntax depends on the error code. For example, QuotaExceededInfo will have details when the error code is QUOTA_EXCEEDED.
error.errors[].errorDetails[].errorInfo
object
error.errors[].errorDetails[].errorInfo.reason
string
The reason of the error. This is a constant value that identifies the proximate cause of the error. Error reasons are unique within a particular domain of errors. This should be at most 63 characters and match a regular expression of [A-Z][A-Z0-9_]+[A-Z0-9]
, which represents UPPER_SNAKE_CASE.
error.errors[].errorDetails[].errorInfo.domain
string
The logical grouping to which the "reason" belongs. The error domain is typically the registered service name of the tool or product that generates the error. Example: "pubsub.googleapis.com". If the error is generated by some common infrastructure, the error domain must be a globally unique value that identifies the infrastructure. For Google API infrastructure, the error domain is "googleapis.com".
error.errors[].errorDetails[].errorInfo.metadatas
map (key: string, value: string)
Additional structured details about this error.
Keys must match /[a-z][a-zA-Z0-9-_]+/ but should ideally be lowerCamelCase. Also they must be limited to 64 characters in length. When identifying the current value of an exceeded limit, the units should be contained in the key, not the value. For example, rather than {"instanceLimit": "100/request"}, should be returned as, {"instanceLimitPerRequest": "100"}, if the client exceeds the number of instances that can be created in a single (batch) request.
error.errors[].errorDetails[].quotaInfo
object
error.errors[].errorDetails[].quotaInfo.metricName
string
The Compute Engine quota metric name.
error.errors[].errorDetails[].quotaInfo.limitName
string
The name of the quota limit.
error.errors[].errorDetails[].quotaInfo.dimensions
map (key: string, value: string)
The map holding related quota dimensions.
error.errors[].errorDetails[].quotaInfo.limit
number
Current effective quota limit. The limit's unit depends on the quota type or metric.
error.errors[].errorDetails[].quotaInfo.futureLimit
number
Future quota limit being rolled out. The limit's unit depends on the quota type or metric.
error.errors[].errorDetails[].quotaInfo.rolloutStatus
enum
Rollout status of the future quota limit.
error.errors[].errorDetails[].help
object
error.errors[].errorDetails[].help.links[]
object
URL(s) pointing to additional information on handling the current error.
error.errors[].errorDetails[].help.links[].description
string
Describes what the link offers.
error.errors[].errorDetails[].help.links[].url
string
The URL of the link.
error.errors[].errorDetails[].localizedMessage
object
error.errors[].errorDetails[].localizedMessage.locale
string
The locale used following the specification defined at https://www.rfc-editor.org/rfc/bcp/bcp47.txt . Examples are: "en-US", "fr-CH", "es-MX"
error.errors[].errorDetails[].localizedMessage.message
string
The localized error message in the above locale.
warnings[]
object
[Output Only] If warning messages are generated during processing of the operation, this field will be populated.
warnings[].code
enum
[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE
if there are no results in the response.
warnings[].message
string
[Output Only] A human-readable description of the warning code.
warnings[].data[]
object
[Output Only] Metadata about this warning in key: value
format. For example:
"data": [ { "key": "scope", "value": "zones/us-east1-d" }
warnings[].data[].key
string
[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope
and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
warnings[].data[].value
string
[Output Only] A warning data value corresponding to the key.
httpErrorStatusCode
integer
[Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404
means the resource was not found.
selfLink
string
[Output Only] Server-defined URL for the resource.
region
string
[Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.
description
string
[Output Only] A textual description of the operation, which is set when the operation is created.
operationGroupId
string
[Output Only] An ID that represents a group of operations, such as when a group of operations results from a bulkInsert
API request.
setCommonInstanceMetadataOperationMetadata.clientOperationId
string
[Output Only] The client operation id.
setCommonInstanceMetadataOperationMetadata.perLocationOperations[]
map (key: string, value: object)
[Output Only] Status information per location (location name is key). Example key: zones/us-central1-a
setCommonInstanceMetadataOperationMetadata.perLocationOperations[].state
enum
[Output Only] Status of the action, which can be one of the following: PROPAGATING
, PROPAGATED
, ABANDONED
, FAILED
, or DONE
.
setCommonInstanceMetadataOperationMetadata.perLocationOperations[].error
object
[Output Only] If state is ABANDONED
or FAILED
, this field is populated.
setCommonInstanceMetadataOperationMetadata.perLocationOperations[].error.code
integer
The status code, which should be an enum value of google.rpc.Code
.
setCommonInstanceMetadataOperationMetadata.perLocationOperations[].error.message
string
A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details
field, or localized by the client.
setCommonInstanceMetadataOperationMetadata.perLocationOperations[].error.details[]
object
A list of messages that carry the error details. There is a common set of message types for APIs to use.
An object containing fields of an arbitrary type. An additional field "@type"
contains a URI identifying the type. Example: { "id": 1234, "@type": "types.example.com/standard/id" }
.
instancesBulkInsertOperationMetadata.perLocationStatus[]
map (key: string, value: object)
Status information per location (location name is key). Example key: zones/us-central1-a
instancesBulkInsertOperationMetadata.perLocationStatus[].status
enum
[Output Only] Creation status of BulkInsert operation - information if the flow is rolling forward or rolling back.
instancesBulkInsertOperationMetadata.perLocationStatus[].targetVmCount
integer
[Output Only] Count of VMs originally planned to be created.
instancesBulkInsertOperationMetadata.perLocationStatus[].createdVmCount
integer
[Output Only] Count of VMs successfully created so far.
instancesBulkInsertOperationMetadata.perLocationStatus[].failedToCreateVmCount
integer
[Output Only] Count of VMs that started creating but encountered an error.
instancesBulkInsertOperationMetadata.perLocationStatus[].deletedVmCount
integer
[Output Only] Count of VMs that got deleted during rollback.
Authorization scopes
Requires one of the following OAuth scopes:
-
https://www.googleapis.com/auth/compute
-
https://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.firewalls.update
To find predefined roles that contain those permissions, see Compute Engine IAM Roles .