Compute Engine API (compute:v1)

▼ ▲ compute.networkFirewallPolicies.list

Parameter Order : project

Scopes :

• https://www.googleapis.com/auth/cloud-platform
• https://www.googleapis.com/auth/compute
• https://www.googleapis.com/auth/compute.readonly

Parameters :

filter

Location : query

Type : string

Description : A filter expression that filters resources listed in the response. The expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` operator can be used with string fields to match substrings. For non-string fields it is equivalent to the `=` operator. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) ```

pageToken

Description : Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.

Type : string

Location : query

orderBy

Type : string

Description : Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy="creationTimestamp desc"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported.

Location : query

returnPartialSuccess

Description : Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.

Location : query

Type : boolean

maxResults

Location : query

Description : The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)

Format : uint32

Type : integer

Minimum : 0

Default : 500

project

Pattern : (?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))

Location : path

Required : Yes

Type : string

Description : Project ID for this request.

Flat Path : projects/{project}/global/firewallPolicies

Path : projects/{project}/global/firewallPolicies

HTTP Method : GET

Description : Lists all the policies that have been configured for the specified project.

▼ ▲ compute.networkFirewallPolicies.patchRule

Scopes :

• https://www.googleapis.com/auth/cloud-platform
• https://www.googleapis.com/auth/compute

Flat Path : projects/{project}/global/firewallPolicies/{firewallPolicy}/patchRule

Parameters :

firewallPolicy

Description : Name of the firewall policy to update.

Type : string

Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}

Required : Yes

Location : path

project

Description : Project ID for this request.

Pattern : (?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))

Type : string

Location : path

Required : Yes

requestId

Type : string

Description : 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 ( 00000000-0000-0000-0000-000000000000).

Location : query

priority

Format : int32

Location : query

Description : The priority of the rule to patch.

Type : integer

HTTP Method : POST

Parameter Order :

• project
• firewallPolicy

Description : Patches a rule of the specified priority.

Path : projects/{project}/global/firewallPolicies/{firewallPolicy}/patchRule

▼ ▲ compute.networkFirewallPolicies.setIamPolicy

Parameter Order :

• project
• resource

HTTP Method : POST

Parameters :

project

Type : string

Description : Project ID for this request.

Pattern : (?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))

Location : path

Required : Yes

resource

Type : string

Location : path

Pattern : [a-z](?:[-a-z0-9_]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}

Required : Yes

Description : Name or id of the resource for this request.

Path : projects/{project}/global/firewallPolicies/{resource}/setIamPolicy

Flat Path : projects/{project}/global/firewallPolicies/{resource}/setIamPolicy

Scopes :

• https://www.googleapis.com/auth/cloud-platform
• https://www.googleapis.com/auth/compute

Description : Sets the access control policy on the specified resource. Replaces any existing policy.

▼ ▲ compute.networkFirewallPolicies.getAssociation

Description : Gets an association with the specified name.

Path : projects/{project}/global/firewallPolicies/{firewallPolicy}/getAssociation

Parameters :

name

Location : query

Type : string

Description : The name of the association to get from the firewall policy.

firewallPolicy

Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}

Type : string

Description : Name of the firewall policy to which the queried association belongs.

Required : Yes

Location : path

project

Description : Project ID for this request.

Required : Yes

Location : path

Type : string

Pattern : (?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))

Flat Path : projects/{project}/global/firewallPolicies/{firewallPolicy}/getAssociation

HTTP Method : GET

Parameter Order :

• project
• firewallPolicy

Scopes :

• https://www.googleapis.com/auth/cloud-platform
• https://www.googleapis.com/auth/compute
• https://www.googleapis.com/auth/compute.readonly

▼ ▲ compute.networkFirewallPolicies.cloneRules

Parameter Order :

• project
• firewallPolicy

Flat Path : projects/{project}/global/firewallPolicies/{firewallPolicy}/cloneRules

HTTP Method : POST

Path : projects/{project}/global/firewallPolicies/{firewallPolicy}/cloneRules

Description : Copies rules to the specified firewall policy.

Parameters :

requestId

Location : query

Description : 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 ( 00000000-0000-0000-0000-000000000000).

Type : string

project

Description : Project ID for this request.

Type : string

Pattern : (?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))

Location : path

Required : Yes

firewallPolicy

Type : string

Description : Name of the firewall policy to update.

Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}

Location : path

Required : Yes

sourceFirewallPolicy

Location : query

Description : The firewall policy from which to copy rules.

Type : string

Scopes :

• https://www.googleapis.com/auth/cloud-platform
• https://www.googleapis.com/auth/compute

▼ ▲ compute.networkFirewallPolicies.insert

Scopes :

• https://www.googleapis.com/auth/cloud-platform
• https://www.googleapis.com/auth/compute

Parameters :

project

Type : string

Location : path

Pattern : (?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))

Required : Yes

Description : Project ID for this request.

requestId

Description : 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 ( 00000000-0000-0000-0000-000000000000).

Location : query

Type : string

Flat Path : projects/{project}/global/firewallPolicies

HTTP Method : POST

Path : projects/{project}/global/firewallPolicies

Parameter Order : project

Description : Creates a new policy in the specified project using the data included in the request.

▼ ▲ compute.networkFirewallPolicies.get

Description : Returns the specified network firewall policy.

HTTP Method : GET

Path : projects/{project}/global/firewallPolicies/{firewallPolicy}

Parameters :

firewallPolicy

Type : string

Required : Yes

Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}

Description : Name of the firewall policy to get.

Location : path

project

Pattern : (?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))

Description : Project ID for this request.

Type : string

Required : Yes

Location : path

Flat Path : projects/{project}/global/firewallPolicies/{firewallPolicy}

Parameter Order :

• project
• firewallPolicy

Scopes :

• https://www.googleapis.com/auth/cloud-platform
• https://www.googleapis.com/auth/compute
• https://www.googleapis.com/auth/compute.readonly

▼ ▲ compute.networkFirewallPolicies.getRule

Description : Gets a rule of the specified priority.

HTTP Method : GET

Parameters :

firewallPolicy

Location : path

Type : string

Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}

Required : Yes

Description : Name of the firewall policy to which the queried rule belongs.

priority

Type : integer

Description : The priority of the rule to get from the firewall policy.

Location : query

Format : int32

project

Pattern : (?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))

Type : string

Description : Project ID for this request.

Location : path

Required : Yes

Path : projects/{project}/global/firewallPolicies/{firewallPolicy}/getRule

Scopes :

• https://www.googleapis.com/auth/cloud-platform
• https://www.googleapis.com/auth/compute
• https://www.googleapis.com/auth/compute.readonly

Flat Path : projects/{project}/global/firewallPolicies/{firewallPolicy}/getRule

Parameter Order :

• project
• firewallPolicy

▼ ▲ compute.networkFirewallPolicies.addRule

Path : projects/{project}/global/firewallPolicies/{firewallPolicy}/addRule

Flat Path : projects/{project}/global/firewallPolicies/{firewallPolicy}/addRule

Description : Inserts a rule into a firewall policy.

HTTP Method : POST

Parameter Order :

• project
• firewallPolicy

Scopes :

• https://www.googleapis.com/auth/cloud-platform
• https://www.googleapis.com/auth/compute

Parameters :

maxPriority

Location : query

Type : integer

Description : When rule.priority is not specified, auto choose a unused priority between minPriority and maxPriority>. This field is exclusive with rule.priority.

Format : int32

requestId

Type : string

Location : query

Description : 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 ( 00000000-0000-0000-0000-000000000000).

minPriority

Type : integer

Description : When rule.priority is not specified, auto choose a unused priority between minPriority and maxPriority>. This field is exclusive with rule.priority.

Format : int32

Location : query

project

Location : path

Required : Yes

Pattern : (?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))

Description : Project ID for this request.

Type : string

firewallPolicy

Required : Yes

Location : path

Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}

Description : Name of the firewall policy to update.

Type : string

▼ ▲ compute.networkFirewallPolicies.delete

HTTP Method : DELETE

Flat Path : projects/{project}/global/firewallPolicies/{firewallPolicy}

Description : Deletes the specified policy.

Parameter Order :

• project
• firewallPolicy

Parameters :

firewallPolicy

Required : Yes

Description : Name of the firewall policy to delete.

Location : path

Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}

Type : string

requestId

Location : query

Type : string

Description : 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 ( 00000000-0000-0000-0000-000000000000).

project

Description : Project ID for this request.

Location : path

Type : string

Required : Yes

Pattern : (?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))

Scopes :

• https://www.googleapis.com/auth/cloud-platform
• https://www.googleapis.com/auth/compute

Path : projects/{project}/global/firewallPolicies/{firewallPolicy}

▼ ▲ compute.networkFirewallPolicies.removeAssociation

Path : projects/{project}/global/firewallPolicies/{firewallPolicy}/removeAssociation

Description : Removes an association for the specified firewall policy.

Parameter Order :

• project
• firewallPolicy

HTTP Method : POST

Scopes :

• https://www.googleapis.com/auth/cloud-platform
• https://www.googleapis.com/auth/compute

Flat Path : projects/{project}/global/firewallPolicies/{firewallPolicy}/removeAssociation

Parameters :

project

Description : Project ID for this request.

Location : path

Required : Yes

Type : string

Pattern : (?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))

firewallPolicy

Location : path

Required : Yes

Type : string

Description : Name of the firewall policy to update.

Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}

name

Description : Name for the attachment that will be removed.

Type : string

Location : query

requestId

Location : query

Type : string

Description : 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 ( 00000000-0000-0000-0000-000000000000).

▼ ▲ compute.networkFirewallPolicies.patch

HTTP Method : PATCH

Parameters :

firewallPolicy

Description : Name of the firewall policy to update.

Type : string

Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}

Required : Yes

Location : path

project

Type : string

Description : Project ID for this request.

Location : path

Required : Yes

Pattern : (?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))

requestId

Type : string

Location : query

Description : 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 ( 00000000-0000-0000-0000-000000000000).

Parameter Order :

• project
• firewallPolicy

Description : Patches the specified policy with the data included in the request.

Path : projects/{project}/global/firewallPolicies/{firewallPolicy}

Scopes :

• https://www.googleapis.com/auth/cloud-platform
• https://www.googleapis.com/auth/compute

Flat Path : projects/{project}/global/firewallPolicies/{firewallPolicy}

▼ ▲ compute.networkFirewallPolicies.addAssociation

Parameters :

replaceExistingAssociation

Description : Indicates whether or not to replace it if an association of the attachment already exists. This is false by default, in which case an error will be returned if an association already exists.

Location : query

Type : boolean

requestId

Type : string

Description : 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 ( 00000000-0000-0000-0000-000000000000).

Location : query

firewallPolicy

Required : Yes

Location : path

Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}

Type : string

Description : Name of the firewall policy to update.

project

Pattern : (?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))

Required : Yes

Location : path

Type : string

Description : Project ID for this request.

Flat Path : projects/{project}/global/firewallPolicies/{firewallPolicy}/addAssociation

HTTP Method : POST

Path : projects/{project}/global/firewallPolicies/{firewallPolicy}/addAssociation

Parameter Order :

• project
• firewallPolicy

Description : Inserts an association for the specified firewall policy.

Scopes :

• https://www.googleapis.com/auth/cloud-platform
• https://www.googleapis.com/auth/compute

▼ ▲ compute.networkFirewallPolicies.removeRule

HTTP Method : POST

Parameters :

priority

Description : The priority of the rule to remove from the firewall policy.

Format : int32

Type : integer

Location : query

firewallPolicy

Type : string

Location : path

Description : Name of the firewall policy to update.

Required : Yes

Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}

project

Required : Yes

Description : Project ID for this request.

Type : string

Location : path

Pattern : (?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))

requestId

Location : query

Description : 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 ( 00000000-0000-0000-0000-000000000000).

Type : string

Description : Deletes a rule of the specified priority.

Scopes :

• https://www.googleapis.com/auth/cloud-platform
• https://www.googleapis.com/auth/compute

Path : projects/{project}/global/firewallPolicies/{firewallPolicy}/removeRule

Parameter Order :

• project
• firewallPolicy

Flat Path : projects/{project}/global/firewallPolicies/{firewallPolicy}/removeRule

▼ ▲ compute.networkFirewallPolicies.getIamPolicy

Parameter Order :

• project
• resource

Description : Gets the access control policy for a resource. May be empty if no such policy or resource exists.

HTTP Method : GET

Path : projects/{project}/global/firewallPolicies/{resource}/getIamPolicy

Parameters :

resource

Required : Yes

Type : string

Location : path

Description : Name or id of the resource for this request.

Pattern : [a-z](?:[-a-z0-9_]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}

optionsRequestedPolicyVersion

Location : query

Type : integer

Description : Requested IAM Policy version.

Format : int32

project

Type : string

Location : path

Description : Project ID for this request.

Required : Yes

Pattern : (?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))

Flat Path : projects/{project}/global/firewallPolicies/{resource}/getIamPolicy

Scopes :

• https://www.googleapis.com/auth/cloud-platform
• https://www.googleapis.com/auth/compute
• https://www.googleapis.com/auth/compute.readonly

▼ ▲ compute.networkFirewallPolicies.testIamPermissions

Parameters :

resource

Required : Yes

Pattern : [a-z](?:[-a-z0-9_]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}

Location : path

Description : Name or id of the resource for this request.

Type : string

project

Pattern : (?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))

Type : string

Required : Yes

Description : Project ID for this request.

Location : path

Flat Path : projects/{project}/global/firewallPolicies/{resource}/testIamPermissions

Description : Returns permissions that a caller has on the specified resource.

HTTP Method : POST

Scopes :

• https://www.googleapis.com/auth/cloud-platform
• https://www.googleapis.com/auth/compute
• https://www.googleapis.com/auth/compute.readonly

Parameter Order :

• project
• resource

Path : projects/{project}/global/firewallPolicies/{resource}/testIamPermissions

▼ ▲ compute.regionNetworkFirewallPolicies.get

Parameters :

firewallPolicy

Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}

Type : string

Description : Name of the firewall policy to get.

Required : Yes

Location : path

project

Type : string

Required : Yes

Pattern : (?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))

Description : Project ID for this request.

Location : path

region

Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?

Type : string

Location : path

Required : Yes

Description : Name of the region scoping this request.

Path : projects/{project}/regions/{region}/firewallPolicies/{firewallPolicy}

Scopes :

• https://www.googleapis.com/auth/cloud-platform
• https://www.googleapis.com/auth/compute
• https://www.googleapis.com/auth/compute.readonly

HTTP Method : GET

Description : Returns the specified network firewall policy.

Flat Path : projects/{project}/regions/{region}/firewallPolicies/{firewallPolicy}

Parameter Order :

• project
• region
• firewallPolicy

▼ ▲ compute.regionNetworkFirewallPolicies.patchRule

Flat Path : projects/{project}/regions/{region}/firewallPolicies/{firewallPolicy}/patchRule

Parameter Order :

• project
• region
• firewallPolicy

Path : projects/{project}/regions/{region}/firewallPolicies/{firewallPolicy}/patchRule

Scopes :

• https://www.googleapis.com/auth/cloud-platform
• https://www.googleapis.com/auth/compute

Description : Patches a rule of the specified priority.

HTTP Method : POST

Parameters :

priority

Type : integer

Location : query

Format : int32

Description : The priority of the rule to patch.

project

Description : Project ID for this request.

Required : Yes

Type : string

Location : path

Pattern : (?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))

region

Type : string

Required : Yes

Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?

Location : path

Description : Name of the region scoping this request.

requestId

Description : 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 ( 00000000-0000-0000-0000-000000000000).

Location : query

Type : string

firewallPolicy

Location : path

Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}

Type : string

Required : Yes

Description : Name of the firewall policy to update.

▼ ▲ compute.regionNetworkFirewallPolicies.setIamPolicy

HTTP Method : POST

Scopes :

• https://www.googleapis.com/auth/cloud-platform
• https://www.googleapis.com/auth/compute

Flat Path : projects/{project}/regions/{region}/firewallPolicies/{resource}/setIamPolicy

Parameters :

region

Location : path

Required : Yes

Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?

Description : The name of the region for this request.

Type : string

project

Location : path

Type : string

Pattern : (?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))

Required : Yes

Description : Project ID for this request.

resource

Location : path

Required : Yes

Description : Name or id of the resource for this request.

Type : string

Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}

Parameter Order :

• project
• region
• resource

Path : projects/{project}/regions/{region}/firewallPolicies/{resource}/setIamPolicy

Description : Sets the access control policy on the specified resource. Replaces any existing policy.

▼ ▲ compute.regionNetworkFirewallPolicies.removeRule

Description : Deletes a rule of the specified priority.

HTTP Method : POST

Parameters :

project

Type : string

Pattern : (?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))

Description : Project ID for this request.

Required : Yes

Location : path

region

Required : Yes

Type : string

Description : Name of the region scoping this request.

Location : path

Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?

requestId

Location : query

Description : 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 ( 00000000-0000-0000-0000-000000000000).

Type : string

firewallPolicy

Description : Name of the firewall policy to update.

Required : Yes

Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}

Location : path

Type : string

priority

Format : int32

Location : query

Type : integer

Description : The priority of the rule to remove from the firewall policy.

Scopes :

• https://www.googleapis.com/auth/cloud-platform
• https://www.googleapis.com/auth/compute

Flat Path : projects/{project}/regions/{region}/firewallPolicies/{firewallPolicy}/removeRule

Parameter Order :

• project
• region
• firewallPolicy

Path : projects/{project}/regions/{region}/firewallPolicies/{firewallPolicy}/removeRule

▼ ▲ compute.regionNetworkFirewallPolicies.list

Scopes :

• https://www.googleapis.com/auth/cloud-platform
• https://www.googleapis.com/auth/compute
• https://www.googleapis.com/auth/compute.readonly

HTTP Method : GET

Parameters :

region

Type : string

Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?

Location : path

Required : Yes

Description : Name of the region scoping this request.

filter

Description : A filter expression that filters resources listed in the response. The expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` operator can be used with string fields to match substrings. For non-string fields it is equivalent to the `=` operator. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) ```

Location : query

Type : string

returnPartialSuccess

Location : query

Description : Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.

Type : boolean

orderBy

Location : query

Description : Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy="creationTimestamp desc"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported.

Type : string

pageToken

Description : Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.

Type : string

Location : query

maxResults

Location : query

Format : uint32

Type : integer

Default : 500

Description : The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)

Minimum : 0

project

Description : Project ID for this request.

Pattern : (?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))

Type : string

Required : Yes

Location : path

Parameter Order :

• project
• region

Path : projects/{project}/regions/{region}/firewallPolicies

Description : Lists all the network firewall policies that have been configured for the specified project in the given region.

Flat Path : projects/{project}/regions/{region}/firewallPolicies

▼ ▲ compute.regionNetworkFirewallPolicies.patch

Path : projects/{project}/regions/{region}/firewallPolicies/{firewallPolicy}

HTTP Method : PATCH

Parameter Order :

• project
• region
• firewallPolicy

Flat Path : projects/{project}/regions/{region}/firewallPolicies/{firewallPolicy}

Scopes :

• https://www.googleapis.com/auth/cloud-platform
• https://www.googleapis.com/auth/compute

Description : Patches the specified network firewall policy.

Parameters :

project

Pattern : (?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))

Location : path

Type : string

Required : Yes

Description : Project ID for this request.

region

Location : path

Type : string

Description : Name of the region scoping this request.

Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?

Required : Yes

firewallPolicy

Description : Name of the firewall policy to update.

Required : Yes

Location : path

Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}

Type : string

requestId

Location : query

Type : string

Description : 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 ( 00000000-0000-0000-0000-000000000000).

▼ ▲ compute.regionNetworkFirewallPolicies.testIamPermissions

HTTP Method : POST

Path : projects/{project}/regions/{region}/firewallPolicies/{resource}/testIamPermissions

Parameter Order :

• project
• region
• resource

Description : Returns permissions that a caller has on the specified resource.

Scopes :

• https://www.googleapis.com/auth/cloud-platform
• https://www.googleapis.com/auth/compute
• https://www.googleapis.com/auth/compute.readonly

Flat Path : projects/{project}/regions/{region}/firewallPolicies/{resource}/testIamPermissions

Parameters :

region

Location : path

Description : The name of the region for this request.

Required : Yes

Type : string

Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?

project

Required : Yes

Location : path

Pattern : (?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))

Type : string

Description : Project ID for this request.

resource

Description : Name or id of the resource for this request.

Required : Yes

Type : string

Location : path

Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}

▼ ▲ compute.regionNetworkFirewallPolicies.getEffectiveFirewalls

Description : Returns the effective firewalls on a given network.

Flat Path : projects/{project}/regions/{region}/firewallPolicies/getEffectiveFirewalls

Parameters :

project

Required : Yes

Description : Project ID for this request.

Pattern : (?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))

Type : string

Location : path

network

Required : Yes

Type : string

Description : Network reference

Location : query

region

Type : string

Description : Name of the region scoping this request.

Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?

Location : path

Required : Yes

Path : projects/{project}/regions/{region}/firewallPolicies/getEffectiveFirewalls

HTTP Method : GET

Scopes :

• https://www.googleapis.com/auth/cloud-platform
• https://www.googleapis.com/auth/compute
• https://www.googleapis.com/auth/compute.readonly

Parameter Order :

• project
• region
• network

▼ ▲ compute.regionNetworkFirewallPolicies.addAssociation

Description : Inserts an association for the specified network firewall policy.

Path : projects/{project}/regions/{region}/firewallPolicies/{firewallPolicy}/addAssociation

HTTP Method : POST

Scopes :

• https://www.googleapis.com/auth/cloud-platform
• https://www.googleapis.com/auth/compute

Flat Path : projects/{project}/regions/{region}/firewallPolicies/{firewallPolicy}/addAssociation

Parameter Order :

• project
• region
• firewallPolicy

Parameters :

replaceExistingAssociation

Type : boolean

Location : query

Description : Indicates whether or not to replace it if an association already exists. This is false by default, in which case an error will be returned if an association already exists.

requestId

Description : 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 ( 00000000-0000-0000-0000-000000000000).

Location : query

Type : string

region

Type : string

Required : Yes

Location : path

Description : Name of the region scoping this request.

Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?

project

Pattern : (?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))

Required : Yes

Location : path

Type : string

Description : Project ID for this request.

firewallPolicy

Required : Yes

Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}

Location : path

Type : string

Description : Name of the firewall policy to update.

▼ ▲ compute.regionNetworkFirewallPolicies.removeAssociation

Path : projects/{project}/regions/{region}/firewallPolicies/{firewallPolicy}/removeAssociation

Scopes :

• https://www.googleapis.com/auth/cloud-platform
• https://www.googleapis.com/auth/compute

Parameter Order :

• project
• region
• firewallPolicy

Flat Path : projects/{project}/regions/{region}/firewallPolicies/{firewallPolicy}/removeAssociation

Parameters :

firewallPolicy

Required : Yes

Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}

Type : string

Description : Name of the firewall policy to update.

Location : path

name

Type : string

Description : Name for the association that will be removed.

Location : query

project

Type : string

Location : path

Required : Yes

Description : Project ID for this request.

Pattern : (?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))

region

Type : string

Description : Name of the region scoping this request.

Required : Yes

Location : path

Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?

requestId

Location : query

Type : string

Description : 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 ( 00000000-0000-0000-0000-000000000000).

HTTP Method : POST

Description : Removes an association for the specified network firewall policy.

▼ ▲ compute.regionNetworkFirewallPolicies.delete

Description : Deletes the specified network firewall policy.

Scopes :

• https://www.googleapis.com/auth/cloud-platform
• https://www.googleapis.com/auth/compute

HTTP Method : DELETE

Parameter Order :

• project
• region
• firewallPolicy

Parameters :

requestId

Location : query

Description : 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 ( 00000000-0000-0000-0000-000000000000).

Type : string

region

Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?

Location : path

Required : Yes

Type : string

Description : Name of the region scoping this request.

firewallPolicy

Type : string

Location : path

Required : Yes

Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}

Description : Name of the firewall policy to delete.

project

Required : Yes

Pattern : (?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))

Description : Project ID for this request.

Location : path

Type : string

Path : projects/{project}/regions/{region}/firewallPolicies/{firewallPolicy}

Flat Path : projects/{project}/regions/{region}/firewallPolicies/{firewallPolicy}

▼ ▲ compute.regionNetworkFirewallPolicies.getAssociation

Parameter Order :

• project
• region
• firewallPolicy

Scopes :

• https://www.googleapis.com/auth/cloud-platform
• https://www.googleapis.com/auth/compute
• https://www.googleapis.com/auth/compute.readonly

Parameters :

project

Type : string

Pattern : (?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))

Description : Project ID for this request.

Required : Yes

Location : path

name

Description : The name of the association to get from the firewall policy.

Type : string

Location : query

region

Description : Name of the region scoping this request.

Type : string

Required : Yes

Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?

Location : path

firewallPolicy

Location : path

Type : string

Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}

Required : Yes

Description : Name of the firewall policy to which the queried association belongs.

HTTP Method : GET

Description : Gets an association with the specified name.

Path : projects/{project}/regions/{region}/firewallPolicies/{firewallPolicy}/getAssociation

Flat Path : projects/{project}/regions/{region}/firewallPolicies/{firewallPolicy}/getAssociation

▼ ▲ compute.regionNetworkFirewallPolicies.cloneRules

Parameter Order :

• project
• region
• firewallPolicy

HTTP Method : POST

Description : Copies rules to the specified network firewall policy.

Path : projects/{project}/regions/{region}/firewallPolicies/{firewallPolicy}/cloneRules

Parameters :

project

Location : path

Type : string

Description : Project ID for this request.

Pattern : (?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))

Required : Yes

requestId

Description : 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 ( 00000000-0000-0000-0000-000000000000).

Type : string

Location : query

firewallPolicy

Type : string

Description : Name of the firewall policy to update.

Location : path

Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}

Required : Yes

region

Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?

Location : path

Required : Yes

Description : Name of the region scoping this request.

Type : string

sourceFirewallPolicy

Type : string

Location : query

Description : The firewall policy from which to copy rules.

Scopes :

• https://www.googleapis.com/auth/cloud-platform
• https://www.googleapis.com/auth/compute

Flat Path : projects/{project}/regions/{region}/firewallPolicies/{firewallPolicy}/cloneRules

▼ ▲ compute.regionNetworkFirewallPolicies.getRule

Flat Path : projects/{project}/regions/{region}/firewallPolicies/{firewallPolicy}/getRule

Parameter Order :

• project
• region
• firewallPolicy

Scopes :

• https://www.googleapis.com/auth/cloud-platform
• https://www.googleapis.com/auth/compute
• https://www.googleapis.com/auth/compute.readonly

Description : Gets a rule of the specified priority.

Parameters :

firewallPolicy

Required : Yes

Description : Name of the firewall policy to which the queried rule belongs.

Type : string

Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}

Location : path

region

Type : string

Required : Yes

Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?

Location : path

Description : Name of the region scoping this request.

priority

Location : query

Type : integer

Description : The priority of the rule to get from the firewall policy.

Format : int32

project

Location : path

Pattern : (?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))

Type : string

Required : Yes

Description : Project ID for this request.

HTTP Method : GET

Path : projects/{project}/regions/{region}/firewallPolicies/{firewallPolicy}/getRule

▼ ▲ compute.regionNetworkFirewallPolicies.addRule

Path : projects/{project}/regions/{region}/firewallPolicies/{firewallPolicy}/addRule

Parameters :

region

Type : string

Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?

Required : Yes

Location : path

Description : Name of the region scoping this request.

firewallPolicy

Description : Name of the firewall policy to update.

Required : Yes

Location : path

Type : string

Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}

project

Description : Project ID for this request.

Type : string

Required : Yes

Pattern : (?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))

Location : path

requestId

Location : query

Type : string

Description : 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 ( 00000000-0000-0000-0000-000000000000).

maxPriority

Location : query

Format : int32

Description : When rule.priority is not specified, auto choose a unused priority between minPriority and maxPriority>. This field is exclusive with rule.priority.

Type : integer

minPriority

Type : integer

Format : int32

Description : When rule.priority is not specified, auto choose a unused priority between minPriority and maxPriority>. This field is exclusive with rule.priority.

Location : query

Parameter Order :

• project
• region
• firewallPolicy

Scopes :

• https://www.googleapis.com/auth/cloud-platform
• https://www.googleapis.com/auth/compute

Flat Path : projects/{project}/regions/{region}/firewallPolicies/{firewallPolicy}/addRule

HTTP Method : POST

Description : Inserts a rule into a network firewall policy.

▼ ▲ compute.regionNetworkFirewallPolicies.getIamPolicy

Flat Path : projects/{project}/regions/{region}/firewallPolicies/{resource}/getIamPolicy

Description : Gets the access control policy for a resource. May be empty if no such policy or resource exists.

Parameter Order :

• project
• region
• resource

Parameters :

project

Type : string

Required : Yes

Location : path

Pattern : (?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))

Description : Project ID for this request.

region

Required : Yes

Description : The name of the region for this request.

Type : string

Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?

Location : path

resource

Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}

Type : string

Description : Name or id of the resource for this request.

Required : Yes

Location : path

optionsRequestedPolicyVersion

Location : query

Description : Requested IAM Policy version.

Type : integer

Format : int32

Path : projects/{project}/regions/{region}/firewallPolicies/{resource}/getIamPolicy

Scopes :

• https://www.googleapis.com/auth/cloud-platform
• https://www.googleapis.com/auth/compute
• https://www.googleapis.com/auth/compute.readonly

HTTP Method : GET

▼ ▲ compute.regionNetworkFirewallPolicies.insert

Flat Path : projects/{project}/regions/{region}/firewallPolicies

Scopes :

• https://www.googleapis.com/auth/cloud-platform
• https://www.googleapis.com/auth/compute

Parameter Order :

• project
• region

Parameters :

project

Type : string

Required : Yes

Location : path

Description : Project ID for this request.

Pattern : (?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))

requestId

Description : 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 ( 00000000-0000-0000-0000-000000000000).

Type : string

Location : query

region

Location : path

Type : string

Description : Name of the region scoping this request.

Required : Yes

Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?

Description : Creates a new network firewall policy in the specified project and region.

Path : projects/{project}/regions/{region}/firewallPolicies

HTTP Method : POST

▼ ▲ compute.networkFirewallPolicies.list

Parameter Order : project

Scopes :

• https://www.googleapis.com/auth/cloud-platform
• https://www.googleapis.com/auth/compute
• https://www.googleapis.com/auth/compute.readonly

Parameters :

filter

Location : query

Type : string

Description : A filter expression that filters resources listed in the response. The expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` operator can be used with string fields to match substrings. For non-string fields it is equivalent to the `=` operator. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) ```

pageToken

Description : Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.

Type : string

Location : query

orderBy

Type : string

Description : Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy="creationTimestamp desc"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported.

Location : query

returnPartialSuccess

Description : Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.

Location : query

Type : boolean

maxResults

Location : query

Description : The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)

Format : uint32

Type : integer

Minimum : 0

Default : 500

project

Pattern : (?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))

Location : path

Required : Yes

Type : string

Description : Project ID for this request.

Flat Path : projects/{project}/global/firewallPolicies

Path : projects/{project}/global/firewallPolicies

HTTP Method : GET

Description : Lists all the policies that have been configured for the specified project.

▼ ▲ compute.networkFirewallPolicies.patchRule

Scopes :

• https://www.googleapis.com/auth/cloud-platform
• https://www.googleapis.com/auth/compute

Flat Path : projects/{project}/global/firewallPolicies/{firewallPolicy}/patchRule

Parameters :

firewallPolicy

Description : Name of the firewall policy to update.

Type : string

Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}

Required : Yes

Location : path

project

Description : Project ID for this request.

Pattern : (?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))

Type : string

Location : path

Required : Yes

requestId

Type : string

Description : 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 ( 00000000-0000-0000-0000-000000000000).

Location : query

priority

Format : int32

Location : query

Description : The priority of the rule to patch.

Type : integer

HTTP Method : POST

Parameter Order :

• project
• firewallPolicy

Description : Patches a rule of the specified priority.

Path : projects/{project}/global/firewallPolicies/{firewallPolicy}/patchRule

▼ ▲ compute.networkFirewallPolicies.setIamPolicy

Parameter Order :

• project
• resource

HTTP Method : POST

Parameters :

project

Type : string

Description : Project ID for this request.

Pattern : (?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))

Location : path

Required : Yes

resource

Type : string

Location : path

Pattern : [a-z](?:[-a-z0-9_]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}

Required : Yes

Description : Name or id of the resource for this request.

Path : projects/{project}/global/firewallPolicies/{resource}/setIamPolicy

Flat Path : projects/{project}/global/firewallPolicies/{resource}/setIamPolicy

Scopes :

• https://www.googleapis.com/auth/cloud-platform
• https://www.googleapis.com/auth/compute

Description : Sets the access control policy on the specified resource. Replaces any existing policy.

▼ ▲ compute.networkFirewallPolicies.getAssociation

Description : Gets an association with the specified name.

Path : projects/{project}/global/firewallPolicies/{firewallPolicy}/getAssociation

Parameters :

name

Location : query

Type : string

Description : The name of the association to get from the firewall policy.

firewallPolicy

Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}

Type : string

Description : Name of the firewall policy to which the queried association belongs.

Required : Yes

Location : path

project

Description : Project ID for this request.

Required : Yes

Location : path

Type : string

Pattern : (?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))

Flat Path : projects/{project}/global/firewallPolicies/{firewallPolicy}/getAssociation

HTTP Method : GET

Parameter Order :

• project
• firewallPolicy

Scopes :

• https://www.googleapis.com/auth/cloud-platform
• https://www.googleapis.com/auth/compute
• https://www.googleapis.com/auth/compute.readonly

▼ ▲ compute.networkFirewallPolicies.cloneRules

Parameter Order :

• project
• firewallPolicy

Flat Path : projects/{project}/global/firewallPolicies/{firewallPolicy}/cloneRules

HTTP Method : POST

Path : projects/{project}/global/firewallPolicies/{firewallPolicy}/cloneRules

Description : Copies rules to the specified firewall policy.

Parameters :

requestId

Location : query

Description : 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 ( 00000000-0000-0000-0000-000000000000).

Type : string

project

Description : Project ID for this request.

Type : string

Pattern : (?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))

Location : path

Required : Yes

firewallPolicy

Type : string

Description : Name of the firewall policy to update.

Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}

Location : path

Required : Yes

sourceFirewallPolicy

Location : query

Description : The firewall policy from which to copy rules.

Type : string

Scopes :

• https://www.googleapis.com/auth/cloud-platform
• https://www.googleapis.com/auth/compute

▼ ▲ compute.networkFirewallPolicies.insert

Scopes :

• https://www.googleapis.com/auth/cloud-platform
• https://www.googleapis.com/auth/compute

Parameters :

project

Type : string

Location : path

Pattern : (?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))

Required : Yes

Description : Project ID for this request.

requestId

Description : 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 ( 00000000-0000-0000-0000-000000000000).

Location : query

Type : string

Flat Path : projects/{project}/global/firewallPolicies

HTTP Method : POST

Path : projects/{project}/global/firewallPolicies

Parameter Order : project

Description : Creates a new policy in the specified project using the data included in the request.

▼ ▲ compute.networkFirewallPolicies.get

Description : Returns the specified network firewall policy.

HTTP Method : GET

Path : projects/{project}/global/firewallPolicies/{firewallPolicy}

Parameters :

firewallPolicy

Type : string

Required : Yes

Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}

Description : Name of the firewall policy to get.

Location : path

project

Pattern : (?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))

Description : Project ID for this request.

Type : string

Required : Yes

Location : path

Flat Path : projects/{project}/global/firewallPolicies/{firewallPolicy}

Parameter Order :

• project
• firewallPolicy

Scopes :

• https://www.googleapis.com/auth/cloud-platform
• https://www.googleapis.com/auth/compute
• https://www.googleapis.com/auth/compute.readonly

▼ ▲ compute.networkFirewallPolicies.getRule

Description : Gets a rule of the specified priority.

HTTP Method : GET

Parameters :

firewallPolicy

Location : path

Type : string

Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}

Required : Yes

Description : Name of the firewall policy to which the queried rule belongs.

priority

Type : integer

Description : The priority of the rule to get from the firewall policy.

Location : query

Format : int32

project

Pattern : (?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))

Type : string

Description : Project ID for this request.

Location : path

Required : Yes

Path : projects/{project}/global/firewallPolicies/{firewallPolicy}/getRule

Scopes :

• https://www.googleapis.com/auth/cloud-platform
• https://www.googleapis.com/auth/compute
• https://www.googleapis.com/auth/compute.readonly

Flat Path : projects/{project}/global/firewallPolicies/{firewallPolicy}/getRule

Parameter Order :

• project
• firewallPolicy

▼ ▲ compute.networkFirewallPolicies.addRule

Path : projects/{project}/global/firewallPolicies/{firewallPolicy}/addRule

Flat Path : projects/{project}/global/firewallPolicies/{firewallPolicy}/addRule

Description : Inserts a rule into a firewall policy.

HTTP Method : POST

Parameter Order :

• project
• firewallPolicy

Scopes :

• https://www.googleapis.com/auth/cloud-platform
• https://www.googleapis.com/auth/compute

Parameters :

maxPriority

Location : query

Type : integer

Description : When rule.priority is not specified, auto choose a unused priority between minPriority and maxPriority>. This field is exclusive with rule.priority.

Format : int32

requestId

Type : string

Location : query

Description : 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 ( 00000000-0000-0000-0000-000000000000).

minPriority

Type : integer

Description : When rule.priority is not specified, auto choose a unused priority between minPriority and maxPriority>. This field is exclusive with rule.priority.

Format : int32

Location : query

project

Location : path

Required : Yes

Pattern : (?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))

Description : Project ID for this request.

Type : string

firewallPolicy

Required : Yes

Location : path

Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}

Description : Name of the firewall policy to update.

Type : string

▼ ▲ compute.networkFirewallPolicies.delete

HTTP Method : DELETE

Flat Path : projects/{project}/global/firewallPolicies/{firewallPolicy}

Description : Deletes the specified policy.

Parameter Order :

• project
• firewallPolicy

Parameters :

firewallPolicy

Required : Yes

Description : Name of the firewall policy to delete.

Location : path

Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}

Type : string

requestId

Location : query

Type : string

Description : 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 ( 00000000-0000-0000-0000-000000000000).

project

Description : Project ID for this request.

Location : path

Type : string

Required : Yes

Pattern : (?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))

Scopes :

• https://www.googleapis.com/auth/cloud-platform
• https://www.googleapis.com/auth/compute

Path : projects/{project}/global/firewallPolicies/{firewallPolicy}

▼ ▲ compute.networkFirewallPolicies.removeAssociation

Path : projects/{project}/global/firewallPolicies/{firewallPolicy}/removeAssociation

Description : Removes an association for the specified firewall policy.

Parameter Order :

• project
• firewallPolicy

HTTP Method : POST

Scopes :

• https://www.googleapis.com/auth/cloud-platform
• https://www.googleapis.com/auth/compute

Flat Path : projects/{project}/global/firewallPolicies/{firewallPolicy}/removeAssociation

Parameters :

project

Description : Project ID for this request.

Location : path

Required : Yes

Type : string

Pattern : (?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))

firewallPolicy

Location : path

Required : Yes

Type : string

Description : Name of the firewall policy to update.

Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}

name

Description : Name for the attachment that will be removed.

Type : string

Location : query

requestId

Location : query

Type : string

Description : 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 ( 00000000-0000-0000-0000-000000000000).

▼ ▲ compute.networkFirewallPolicies.patch

HTTP Method : PATCH

Parameters :

firewallPolicy

Description : Name of the firewall policy to update.

Type : string

Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}

Required : Yes

Location : path

project

Type : string

Description : Project ID for this request.

Location : path

Required : Yes

Pattern : (?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))

requestId

Type : string

Location : query

Description : 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 ( 00000000-0000-0000-0000-000000000000).

Parameter Order :

• project
• firewallPolicy

Description : Patches the specified policy with the data included in the request.

Path : projects/{project}/global/firewallPolicies/{firewallPolicy}

Scopes :

• https://www.googleapis.com/auth/cloud-platform
• https://www.googleapis.com/auth/compute

Flat Path : projects/{project}/global/firewallPolicies/{firewallPolicy}

▼ ▲ compute.networkFirewallPolicies.addAssociation

Parameters :

replaceExistingAssociation

Description : Indicates whether or not to replace it if an association of the attachment already exists. This is false by default, in which case an error will be returned if an association already exists.

Location : query

Type : boolean

requestId

Type : string

Description : 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 ( 00000000-0000-0000-0000-000000000000).

Location : query

firewallPolicy

Required : Yes

Location : path

Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}

Type : string

Description : Name of the firewall policy to update.

project

Pattern : (?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))

Required : Yes

Location : path

Type : string

Description : Project ID for this request.

Flat Path : projects/{project}/global/firewallPolicies/{firewallPolicy}/addAssociation

HTTP Method : POST

Path : projects/{project}/global/firewallPolicies/{firewallPolicy}/addAssociation

Parameter Order :

• project
• firewallPolicy

Description : Inserts an association for the specified firewall policy.

Scopes :

• https://www.googleapis.com/auth/cloud-platform
• https://www.googleapis.com/auth/compute

▼ ▲ compute.networkFirewallPolicies.removeRule

HTTP Method : POST

Parameters :

priority

Description : The priority of the rule to remove from the firewall policy.

Format : int32

Type : integer

Location : query

firewallPolicy

Type : string

Location : path

Description : Name of the firewall policy to update.

Required : Yes

Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}

project

Required : Yes

Description : Project ID for this request.

Type : string

Location : path

Pattern : (?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))

requestId

Location : query

Description : 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 ( 00000000-0000-0000-0000-000000000000).

Type : string

Description : Deletes a rule of the specified priority.

Scopes :

• https://www.googleapis.com/auth/cloud-platform
• https://www.googleapis.com/auth/compute

Path : projects/{project}/global/firewallPolicies/{firewallPolicy}/removeRule

Parameter Order :

• project
• firewallPolicy

Flat Path : projects/{project}/global/firewallPolicies/{firewallPolicy}/removeRule

▼ ▲ compute.networkFirewallPolicies.getIamPolicy

Parameter Order :

• project
• resource

Description : Gets the access control policy for a resource. May be empty if no such policy or resource exists.

HTTP Method : GET

Path : projects/{project}/global/firewallPolicies/{resource}/getIamPolicy

Parameters :

resource

Required : Yes

Type : string

Location : path

Description : Name or id of the resource for this request.

Pattern : [a-z](?:[-a-z0-9_]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}

optionsRequestedPolicyVersion

Location : query

Type : integer

Description : Requested IAM Policy version.

Format : int32

project

Type : string

Location : path

Description : Project ID for this request.

Required : Yes

Pattern : (?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))

Flat Path : projects/{project}/global/firewallPolicies/{resource}/getIamPolicy

Scopes :

• https://www.googleapis.com/auth/cloud-platform
• https://www.googleapis.com/auth/compute
• https://www.googleapis.com/auth/compute.readonly

▼ ▲ compute.networkFirewallPolicies.testIamPermissions

Parameters :

resource

Required : Yes

Pattern : [a-z](?:[-a-z0-9_]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}

Location : path

Description : Name or id of the resource for this request.

Type : string

project

Pattern : (?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))

Type : string

Required : Yes

Description : Project ID for this request.

Location : path

Flat Path : projects/{project}/global/firewallPolicies/{resource}/testIamPermissions

Description : Returns permissions that a caller has on the specified resource.

HTTP Method : POST

Scopes :

• https://www.googleapis.com/auth/cloud-platform
• https://www.googleapis.com/auth/compute
• https://www.googleapis.com/auth/compute.readonly

Parameter Order :

• project
• resource

Path : projects/{project}/global/firewallPolicies/{resource}/testIamPermissions

▼ ▲ compute.regionNetworkFirewallPolicies.get

Parameters :

firewallPolicy

Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}

Type : string

Description : Name of the firewall policy to get.

Required : Yes

Location : path

project

Type : string

Required : Yes

Pattern : (?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))

Description : Project ID for this request.

Location : path

region

Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?

Type : string

Location : path

Required : Yes

Description : Name of the region scoping this request.

Path : projects/{project}/regions/{region}/firewallPolicies/{firewallPolicy}

Scopes :

• https://www.googleapis.com/auth/cloud-platform
• https://www.googleapis.com/auth/compute
• https://www.googleapis.com/auth/compute.readonly

HTTP Method : GET

Description : Returns the specified network firewall policy.

Flat Path : projects/{project}/regions/{region}/firewallPolicies/{firewallPolicy}

Parameter Order :

• project
• region
• firewallPolicy

▼ ▲ compute.regionNetworkFirewallPolicies.patchRule

Flat Path : projects/{project}/regions/{region}/firewallPolicies/{firewallPolicy}/patchRule

Parameter Order :

• project
• region
• firewallPolicy

Path : projects/{project}/regions/{region}/firewallPolicies/{firewallPolicy}/patchRule

Scopes :

• https://www.googleapis.com/auth/cloud-platform
• https://www.googleapis.com/auth/compute

Description : Patches a rule of the specified priority.

HTTP Method : POST

Parameters :

priority

Type : integer

Location : query

Format : int32

Description : The priority of the rule to patch.

project

Description : Project ID for this request.

Required : Yes

Type : string

Location : path

Pattern : (?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))

region

Type : string

Required : Yes

Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?

Location : path

Description : Name of the region scoping this request.

requestId

Description : 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 ( 00000000-0000-0000-0000-000000000000).

Location : query

Type : string

firewallPolicy

Location : path

Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}

Type : string

Required : Yes

Description : Name of the firewall policy to update.

▼ ▲ compute.regionNetworkFirewallPolicies.setIamPolicy

HTTP Method : POST

Scopes :

• https://www.googleapis.com/auth/cloud-platform
• https://www.googleapis.com/auth/compute

Flat Path : projects/{project}/regions/{region}/firewallPolicies/{resource}/setIamPolicy

Parameters :

region

Location : path

Required : Yes

Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?

Description : The name of the region for this request.

Type : string

project

Location : path

Type : string

Pattern : (?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))

Required : Yes

Description : Project ID for this request.

resource

Location : path

Required : Yes

Description : Name or id of the resource for this request.

Type : string

Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}

Parameter Order :

• project
• region
• resource

Path : projects/{project}/regions/{region}/firewallPolicies/{resource}/setIamPolicy

Description : Sets the access control policy on the specified resource. Replaces any existing policy.

▼ ▲ compute.regionNetworkFirewallPolicies.removeRule

Description : Deletes a rule of the specified priority.

HTTP Method : POST

Parameters :

project

Type : string

Pattern : (?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))

Description : Project ID for this request.

Required : Yes

Location : path

region

Required : Yes

Type : string

Description : Name of the region scoping this request.

Location : path

Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?

requestId

Location : query

Description : 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 ( 00000000-0000-0000-0000-000000000000).

Type : string

firewallPolicy

Description : Name of the firewall policy to update.

Required : Yes

Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}

Location : path

Type : string

priority

Format : int32

Location : query

Type : integer

Description : The priority of the rule to remove from the firewall policy.

Scopes :

• https://www.googleapis.com/auth/cloud-platform
• https://www.googleapis.com/auth/compute

Flat Path : projects/{project}/regions/{region}/firewallPolicies/{firewallPolicy}/removeRule

Parameter Order :

• project
• region
• firewallPolicy

Path : projects/{project}/regions/{region}/firewallPolicies/{firewallPolicy}/removeRule

▼ ▲ compute.regionNetworkFirewallPolicies.list

Scopes :

• https://www.googleapis.com/auth/cloud-platform
• https://www.googleapis.com/auth/compute
• https://www.googleapis.com/auth/compute.readonly

HTTP Method : GET

Parameters :

region

Type : string

Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?

Location : path

Required : Yes

Description : Name of the region scoping this request.

filter

Description : A filter expression that filters resources listed in the response. The expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` operator can be used with string fields to match substrings. For non-string fields it is equivalent to the `=` operator. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) ```

Location : query

Type : string

returnPartialSuccess

Location : query

Description : Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.

Type : boolean

orderBy

Location : query

Description : Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy="creationTimestamp desc"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported.

Type : string

pageToken

Description : Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.

Type : string

Location : query

maxResults

Location : query

Format : uint32

Type : integer

Default : 500

Description : The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)

Minimum : 0

project

Description : Project ID for this request.

Pattern : (?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))

Type : string

Required : Yes

Location : path

Parameter Order :

• project
• region

Path : projects/{project}/regions/{region}/firewallPolicies

Description : Lists all the network firewall policies that have been configured for the specified project in the given region.

Flat Path : projects/{project}/regions/{region}/firewallPolicies

▼ ▲ compute.regionNetworkFirewallPolicies.patch

Path : projects/{project}/regions/{region}/firewallPolicies/{firewallPolicy}

HTTP Method : PATCH

Parameter Order :

• project
• region
• firewallPolicy

Flat Path : projects/{project}/regions/{region}/firewallPolicies/{firewallPolicy}

Scopes :

• https://www.googleapis.com/auth/cloud-platform
• https://www.googleapis.com/auth/compute

Description : Patches the specified network firewall policy.

Parameters :

project

Pattern : (?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))

Location : path

Type : string

Required : Yes

Description : Project ID for this request.

region

Location : path

Type : string

Description : Name of the region scoping this request.

Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?

Required : Yes

firewallPolicy

Description : Name of the firewall policy to update.

Required : Yes

Location : path

Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}

Type : string

requestId

Location : query

Type : string

Description : 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 ( 00000000-0000-0000-0000-000000000000).

▼ ▲ compute.regionNetworkFirewallPolicies.testIamPermissions

HTTP Method : POST

Path : projects/{project}/regions/{region}/firewallPolicies/{resource}/testIamPermissions

Parameter Order :

• project
• region
• resource

Description : Returns permissions that a caller has on the specified resource.

Scopes :

• https://www.googleapis.com/auth/cloud-platform
• https://www.googleapis.com/auth/compute
• https://www.googleapis.com/auth/compute.readonly

Flat Path : projects/{project}/regions/{region}/firewallPolicies/{resource}/testIamPermissions

Parameters :

region

Location : path

Description : The name of the region for this request.

Required : Yes

Type : string

Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?

project

Required : Yes

Location : path

Pattern : (?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))

Type : string

Description : Project ID for this request.

resource

Description : Name or id of the resource for this request.

Required : Yes

Type : string

Location : path

Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}

▼ ▲ compute.regionNetworkFirewallPolicies.getEffectiveFirewalls

Description : Returns the effective firewalls on a given network.

Flat Path : projects/{project}/regions/{region}/firewallPolicies/getEffectiveFirewalls

Parameters :

project

Required : Yes

Description : Project ID for this request.

Pattern : (?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))

Type : string

Location : path

network

Required : Yes

Type : string

Description : Network reference

Location : query

region

Type : string

Description : Name of the region scoping this request.

Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?

Location : path

Required : Yes

Path : projects/{project}/regions/{region}/firewallPolicies/getEffectiveFirewalls

HTTP Method : GET

Scopes :

• https://www.googleapis.com/auth/cloud-platform
• https://www.googleapis.com/auth/compute
• https://www.googleapis.com/auth/compute.readonly

Parameter Order :

• project
• region
• network

▼ ▲ compute.regionNetworkFirewallPolicies.addAssociation

Description : Inserts an association for the specified network firewall policy.

Path : projects/{project}/regions/{region}/firewallPolicies/{firewallPolicy}/addAssociation

HTTP Method : POST

Scopes :

• https://www.googleapis.com/auth/cloud-platform
• https://www.googleapis.com/auth/compute

Flat Path : projects/{project}/regions/{region}/firewallPolicies/{firewallPolicy}/addAssociation

Parameter Order :

• project
• region
• firewallPolicy

Parameters :

replaceExistingAssociation

Type : boolean

Location : query

Description : Indicates whether or not to replace it if an association already exists. This is false by default, in which case an error will be returned if an association already exists.

requestId

Description : 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 ( 00000000-0000-0000-0000-000000000000).

Location : query

Type : string

region

Type : string

Required : Yes

Location : path

Description : Name of the region scoping this request.

Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?

project

Pattern : (?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))

Required : Yes

Location : path

Type : string

Description : Project ID for this request.

firewallPolicy

Required : Yes

Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}

Location : path

Type : string

Description : Name of the firewall policy to update.

▼ ▲ compute.regionNetworkFirewallPolicies.removeAssociation

Path : projects/{project}/regions/{region}/firewallPolicies/{firewallPolicy}/removeAssociation

Scopes :

• https://www.googleapis.com/auth/cloud-platform
• https://www.googleapis.com/auth/compute

Parameter Order :

• project
• region
• firewallPolicy

Flat Path : projects/{project}/regions/{region}/firewallPolicies/{firewallPolicy}/removeAssociation

Parameters :

firewallPolicy

Required : Yes

Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}

Type : string

Description : Name of the firewall policy to update.

Location : path

name

Type : string

Description : Name for the association that will be removed.

Location : query

project

Type : string

Location : path

Required : Yes

Description : Project ID for this request.

Pattern : (?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))

region

Type : string

Description : Name of the region scoping this request.

Required : Yes

Location : path

Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?

requestId

Location : query

Type : string

Description : 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 ( 00000000-0000-0000-0000-000000000000).

HTTP Method : POST

Description : Removes an association for the specified network firewall policy.

▼ ▲ compute.regionNetworkFirewallPolicies.delete

Description : Deletes the specified network firewall policy.

Scopes :

• https://www.googleapis.com/auth/cloud-platform
• https://www.googleapis.com/auth/compute

HTTP Method : DELETE

Parameter Order :

• project
• region
• firewallPolicy

Parameters :

requestId

Location : query

Description : 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 ( 00000000-0000-0000-0000-000000000000).

Type : string

region

Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?

Location : path

Required : Yes

Type : string

Description : Name of the region scoping this request.

firewallPolicy

Type : string

Location : path

Required : Yes

Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}

Description : Name of the firewall policy to delete.

project

Required : Yes

Pattern : (?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))

Description : Project ID for this request.

Location : path

Type : string

Path : projects/{project}/regions/{region}/firewallPolicies/{firewallPolicy}

Flat Path : projects/{project}/regions/{region}/firewallPolicies/{firewallPolicy}

▼ ▲ compute.regionNetworkFirewallPolicies.getAssociation

Parameter Order :

• project
• region
• firewallPolicy

Scopes :

• https://www.googleapis.com/auth/cloud-platform
• https://www.googleapis.com/auth/compute
• https://www.googleapis.com/auth/compute.readonly

Parameters :

project

Type : string

Pattern : (?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))

Description : Project ID for this request.

Required : Yes

Location : path

name

Description : The name of the association to get from the firewall policy.

Type : string

Location : query

region

Description : Name of the region scoping this request.

Type : string

Required : Yes

Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?

Location : path

firewallPolicy

Location : path

Type : string

Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}

Required : Yes

Description : Name of the firewall policy to which the queried association belongs.

HTTP Method : GET

Description : Gets an association with the specified name.

Path : projects/{project}/regions/{region}/firewallPolicies/{firewallPolicy}/getAssociation

Flat Path : projects/{project}/regions/{region}/firewallPolicies/{firewallPolicy}/getAssociation

▼ ▲ compute.regionNetworkFirewallPolicies.cloneRules

Parameter Order :

• project
• region
• firewallPolicy

HTTP Method : POST

Description : Copies rules to the specified network firewall policy.

Path : projects/{project}/regions/{region}/firewallPolicies/{firewallPolicy}/cloneRules

Parameters :

project

Location : path

Type : string

Description : Project ID for this request.

Pattern : (?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))

Required : Yes

requestId

Description : 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 ( 00000000-0000-0000-0000-000000000000).

Type : string

Location : query

firewallPolicy

Type : string

Description : Name of the firewall policy to update.

Location : path

Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}

Required : Yes

region

Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?

Location : path

Required : Yes

Description : Name of the region scoping this request.

Type : string

sourceFirewallPolicy

Type : string

Location : query

Description : The firewall policy from which to copy rules.

Scopes :

• https://www.googleapis.com/auth/cloud-platform
• https://www.googleapis.com/auth/compute

Flat Path : projects/{project}/regions/{region}/firewallPolicies/{firewallPolicy}/cloneRules

▼ ▲ compute.regionNetworkFirewallPolicies.getRule

Flat Path : projects/{project}/regions/{region}/firewallPolicies/{firewallPolicy}/getRule

Parameter Order :

• project
• region
• firewallPolicy

Scopes :

• https://www.googleapis.com/auth/cloud-platform
• https://www.googleapis.com/auth/compute
• https://www.googleapis.com/auth/compute.readonly

Description : Gets a rule of the specified priority.

Parameters :

firewallPolicy

Required : Yes

Description : Name of the firewall policy to which the queried rule belongs.

Type : string

Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}

Location : path

region

Type : string

Required : Yes

Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?

Location : path

Description : Name of the region scoping this request.

priority

Location : query

Type : integer

Description : The priority of the rule to get from the firewall policy.

Format : int32

project

Location : path

Pattern : (?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))

Type : string

Required : Yes

Description : Project ID for this request.

HTTP Method : GET

Path : projects/{project}/regions/{region}/firewallPolicies/{firewallPolicy}/getRule

▼ ▲ compute.regionNetworkFirewallPolicies.addRule

Path : projects/{project}/regions/{region}/firewallPolicies/{firewallPolicy}/addRule

Parameters :

region

Type : string

Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?

Required : Yes

Location : path

Description : Name of the region scoping this request.

firewallPolicy

Description : Name of the firewall policy to update.

Required : Yes

Location : path

Type : string

Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}

project

Description : Project ID for this request.

Type : string

Required : Yes

Pattern : (?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))

Location : path

requestId

Location : query

Type : string

Description : 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 ( 00000000-0000-0000-0000-000000000000).

maxPriority

Location : query

Format : int32

Description : When rule.priority is not specified, auto choose a unused priority between minPriority and maxPriority>. This field is exclusive with rule.priority.

Type : integer

minPriority

Type : integer

Format : int32

Description : When rule.priority is not specified, auto choose a unused priority between minPriority and maxPriority>. This field is exclusive with rule.priority.

Location : query

Parameter Order :

• project
• region
• firewallPolicy

Scopes :

• https://www.googleapis.com/auth/cloud-platform
• https://www.googleapis.com/auth/compute

Flat Path : projects/{project}/regions/{region}/firewallPolicies/{firewallPolicy}/addRule

HTTP Method : POST

Description : Inserts a rule into a network firewall policy.

▼ ▲ compute.regionNetworkFirewallPolicies.getIamPolicy

Flat Path : projects/{project}/regions/{region}/firewallPolicies/{resource}/getIamPolicy

Description : Gets the access control policy for a resource. May be empty if no such policy or resource exists.

Parameter Order :

• project
• region
• resource

Parameters :

project

Type : string

Required : Yes

Location : path

Pattern : (?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))

Description : Project ID for this request.

region

Required : Yes

Description : The name of the region for this request.

Type : string

Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?

Location : path

resource

Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}

Type : string

Description : Name or id of the resource for this request.

Required : Yes

Location : path

optionsRequestedPolicyVersion

Location : query

Description : Requested IAM Policy version.

Type : integer

Format : int32

Path : projects/{project}/regions/{region}/firewallPolicies/{resource}/getIamPolicy

Scopes :

• https://www.googleapis.com/auth/cloud-platform
• https://www.googleapis.com/auth/compute
• https://www.googleapis.com/auth/compute.readonly

HTTP Method : GET

▼ ▲ compute.regionNetworkFirewallPolicies.insert

Flat Path : projects/{project}/regions/{region}/firewallPolicies

Scopes :

• https://www.googleapis.com/auth/cloud-platform
• https://www.googleapis.com/auth/compute

Parameter Order :

• project
• region

Parameters :

project

Type : string

Required : Yes

Location : path

Description : Project ID for this request.

Pattern : (?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))

requestId

Description : 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 ( 00000000-0000-0000-0000-000000000000).

Type : string

Location : query

region

Location : path

Type : string

Description : Name of the region scoping this request.

Required : Yes

Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?

Description : Creates a new network firewall policy in the specified project and region.

Path : projects/{project}/regions/{region}/firewallPolicies

HTTP Method : POST