2025-09-30
▼ ▲ compute.organizationSecurityPolicies.list
Path : locations/global/securityPolicies
Flat Path : locations/global/securityPolicies
HTTP Method : GET
Parameters :
filter
Description : A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your 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 `:*` 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) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq "double quoted literal"` `(fieldname1 eq literal) (fieldname2 ne "literal")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name "instance", you would use `name ne .*instance`. You cannot combine constraints on multiple fields using regular expressions.
Location : query
Type : string
maxResults
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`)
Default : 500
Minimum : 0
Location : query
Type : integer
Format : uint32
orderBy
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
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.
Location : query
Type : string
parentId
Description : Parent ID for this request.
Location : query
Type : string
returnPartialSuccess
Description : Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.
Location : query
Type : boolean
Scopes :
Description : List all the policies that have been configured for the specified project. Use of this API to read firewall policies is deprecated. Use firewallPolicies.list instead.
▼ ▲ compute.organizationSecurityPolicies.get
Path : locations/global/securityPolicies/{securityPolicy}
Flat Path : locations/global/securityPolicies/{securityPolicy}
HTTP Method : GET
Parameters :
securityPolicy
Description : Name of the security policy to get.
Pattern : (securityPolicies/)?[0-9]{0,20}
Location : path
Required : Yes
Type : string
Parameter Order : securityPolicy
Scopes :
Description : List all of the ordered rules present in a single specified policy. Use of this API to read firewall policies is deprecated. Use firewallPolicies.get instead.
▼ ▲ compute.organizationSecurityPolicies.insert
Path : locations/global/securityPolicies
Flat Path : locations/global/securityPolicies
HTTP Method : POST
Parameters :
parentId
Description : Parent ID for this request. The ID can be either be "folders/[FOLDER_ID]" if the parent is a folder or "organizations/[ORGANIZATION_ID]" if the parent is an organization.
Location : query
Type : string
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
Scopes :
Description : Creates a new policy in the specified project using the data included in the request. Use of this API to insert firewall policies is deprecated. Use firewallPolicies.insert instead.
▼ ▲ compute.organizationSecurityPolicies.delete
Path : locations/global/securityPolicies/{securityPolicy}
Flat Path : locations/global/securityPolicies/{securityPolicy}
HTTP Method : DELETE
Parameters :
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
securityPolicy
Description : Name of the security policy to delete.
Pattern : (securityPolicies/)?[0-9]{0,20}
Location : path
Required : Yes
Type : string
Parameter Order : securityPolicy
Scopes :
Description : Deletes the specified policy. Use of this API to remove firewall policies is deprecated. Use firewallPolicies.delete instead.
▼ ▲ compute.organizationSecurityPolicies.patch
Path : locations/global/securityPolicies/{securityPolicy}
Flat Path : locations/global/securityPolicies/{securityPolicy}
HTTP Method : PATCH
Parameters :
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
securityPolicy
Description : Name of the security policy to update.
Pattern : (securityPolicies/)?[0-9]{0,20}
Location : path
Required : Yes
Type : string
Parameter Order : securityPolicy
Scopes :
Description : Patches the specified policy with the data included in the request. Use of this API to modify firewall policies is deprecated. Use firewallPolicies.patch instead.
▼ ▲ compute.organizationSecurityPolicies.getRule
Path : locations/global/securityPolicies/{securityPolicy}/getRule
Flat Path : locations/global/securityPolicies/{securityPolicy}/getRule
HTTP Method : GET
Parameters :
priority
Description : The priority of the rule to get from the security policy.
Location : query
Type : integer
Format : int32
securityPolicy
Description : Name of the security policy to which the queried rule belongs.
Pattern : (securityPolicies/)?[0-9]{0,20}
Location : path
Required : Yes
Type : string
Parameter Order : securityPolicy
Scopes :
Description : Gets a rule at the specified priority. Use of this API to read firewall policies is deprecated. Use firewallPolicies.getRule instead.
▼ ▲ compute.organizationSecurityPolicies.addRule
Path : locations/global/securityPolicies/{securityPolicy}/addRule
Flat Path : locations/global/securityPolicies/{securityPolicy}/addRule
HTTP Method : POST
Parameters :
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
securityPolicy
Description : Name of the security policy to update.
Pattern : (securityPolicies/)?[0-9]{0,20}
Location : path
Required : Yes
Type : string
Parameter Order : securityPolicy
Scopes :
Description : Inserts a rule into a security policy.
▼ ▲ compute.organizationSecurityPolicies.removeRule
Path : locations/global/securityPolicies/{securityPolicy}/removeRule
Flat Path : locations/global/securityPolicies/{securityPolicy}/removeRule
HTTP Method : POST
Parameters :
priority
Description : The priority of the rule to remove from the security policy.
Location : query
Type : integer
Format : int32
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
securityPolicy
Description : Name of the security policy to update.
Pattern : (securityPolicies/)?[0-9]{0,20}
Location : path
Required : Yes
Type : string
Parameter Order : securityPolicy
Scopes :
Description : Deletes a rule at the specified priority.
▼ ▲ compute.organizationSecurityPolicies.patchRule
Path : locations/global/securityPolicies/{securityPolicy}/patchRule
Flat Path : locations/global/securityPolicies/{securityPolicy}/patchRule
HTTP Method : POST
Parameters :
priority
Description : The priority of the rule to patch.
Location : query
Type : integer
Format : int32
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
securityPolicy
Description : Name of the security policy to update.
Pattern : (securityPolicies/)?[0-9]{0,20}
Location : path
Required : Yes
Type : string
Parameter Order : securityPolicy
Scopes :
Description : Patches a rule at the specified priority. Use of this API to modify firewall policies is deprecated. Use firewallPolicies.patchRule instead.
▼ ▲ compute.organizationSecurityPolicies.listPreconfiguredExpressionSets
Path : locations/global/securityPolicies/listPreconfiguredExpressionSets
Flat Path : locations/global/securityPolicies/listPreconfiguredExpressionSets
HTTP Method : GET
Parameters :
filter
Description : A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your 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 `:*` 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) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq "double quoted literal"` `(fieldname1 eq literal) (fieldname2 ne "literal")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name "instance", you would use `name ne .*instance`. You cannot combine constraints on multiple fields using regular expressions.
Location : query
Type : string
maxResults
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`)
Default : 500
Minimum : 0
Location : query
Type : integer
Format : uint32
orderBy
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
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.
Location : query
Type : string
parentId
Description : Parent ID for this request.
Location : query
Type : string
returnPartialSuccess
Description : Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.
Location : query
Type : boolean
Scopes :
Description : Gets the current list of preconfigured Web Application Firewall (WAF) expressions.
▼ ▲ compute.organizationSecurityPolicies.addAssociation
Path : locations/global/securityPolicies/{securityPolicy}/addAssociation
Flat Path : locations/global/securityPolicies/{securityPolicy}/addAssociation
HTTP Method : POST
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
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
securityPolicy
Description : Name of the security policy to update.
Pattern : (securityPolicies/)?[0-9]{0,20}
Location : path
Required : Yes
Type : string
Parameter Order : securityPolicy
Scopes :
Description : Inserts an association for the specified security policy. This has billing implications. Projects in the hierarchy with effective hierarchical security policies will be automatically enrolled into Cloud Armor Enterprise if not already enrolled. Use of this API to modify firewall policies is deprecated. Use firewallPolicies.addAssociation instead if possible.
▼ ▲ compute.organizationSecurityPolicies.removeAssociation
Path : locations/global/securityPolicies/{securityPolicy}/removeAssociation
Flat Path : locations/global/securityPolicies/{securityPolicy}/removeAssociation
HTTP Method : POST
Parameters :
name
Description : Name for the attachment that will be removed.
Location : query
Type : string
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
securityPolicy
Description : Name of the security policy to update.
Pattern : (securityPolicies/)?[0-9]{0,20}
Location : path
Required : Yes
Type : string
Parameter Order : securityPolicy
Scopes :
Description : Removes an association for the specified security policy. Use of this API to modify firewall policies is deprecated. Use firewallPolicies.removeAssociation instead if possible.
▼ ▲ compute.organizationSecurityPolicies.listAssociations
Path : locations/global/securityPolicies/listAssociations
Flat Path : locations/global/securityPolicies/listAssociations
HTTP Method : GET
Parameters :
targetResource
Description : The target resource to list associations. It is an organization, or a folder.
Location : query
Type : string
Scopes :
Description : Lists associations of a specified target, i.e., organization or folder. Use of this API to read firewall policies is deprecated. Use firewallPolicies.listAssociations instead if possible.
▼ ▲ compute.organizationSecurityPolicies.getAssociation
Path : locations/global/securityPolicies/{securityPolicy}/getAssociation
Flat Path : locations/global/securityPolicies/{securityPolicy}/getAssociation
HTTP Method : GET
Parameters :
name
Description : The name of the association to get from the security policy.
Location : query
Type : string
securityPolicy
Description : Name of the security policy to which the queried rule belongs.
Pattern : (securityPolicies/)?[0-9]{0,20}
Location : path
Required : Yes
Type : string
Parameter Order : securityPolicy
Scopes :
Description : Gets an association with the specified name. Use of this API to read firewall policies is deprecated. Use firewallPolicies.getAssociation instead if possible.
▼ ▲ compute.organizationSecurityPolicies.copyRules
Path : locations/global/securityPolicies/{securityPolicy}/copyRules
Flat Path : locations/global/securityPolicies/{securityPolicy}/copyRules
HTTP Method : POST
Parameters :
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
securityPolicy
Description : Name of the security policy to update.
Pattern : (securityPolicies/)?[0-9]{0,20}
Location : path
Required : Yes
Type : string
sourceSecurityPolicy
Description : The security policy from which to copy rules.
Location : query
Type : string
Parameter Order : securityPolicy
Scopes :
Description : Copies rules to the specified security policy. Use of this API to modify firewall policies is deprecated. Use firewallPolicies.copyRules instead.
▼ ▲ compute.organizationSecurityPolicies.move
Path : locations/global/securityPolicies/{securityPolicy}/move
Flat Path : locations/global/securityPolicies/{securityPolicy}/move
HTTP Method : POST
Parameters :
parentId
Description : The new parent of the security policy.
Location : query
Type : string
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
securityPolicy
Description : Name of the security policy to update.
Pattern : (securityPolicies/)?[0-9]{0,20}
Location : path
Required : Yes
Type : string
Parameter Order : securityPolicy
Scopes :
Description : Moves the specified security policy. Use of this API to modify firewall policies is deprecated. Use firewallPolicies.move instead.
▼ ▲ compute.backendServices.getEffectiveSecurityPolicies
Path : projects/{project}/global/backendServices/{backendService}/getEffectiveSecurityPolicies
Flat Path : projects/{project}/global/backendServices/{backendService}/getEffectiveSecurityPolicies
HTTP Method : GET
Parameters :
backendService
Description : Name of the Backend Service for this request.
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Location : path
Required : Yes
Type : string
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])?))
Location : path
Required : Yes
Type : string
Parameter Order :
Scopes :
Description : Returns effective security policies applied to this backend service.
▼ ▲ compute.previewFeatures.get
Path : projects/{project}/global/previewFeatures/{previewFeature}
Flat Path : projects/{project}/global/previewFeatures/{previewFeature}
HTTP Method : GET
Parameters :
previewFeature
Description : Name of the PreviewFeature for this request.
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Location : path
Required : Yes
Type : string
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])?))
Location : path
Required : Yes
Type : string
Parameter Order :
Scopes :
Description : Returns the details of the given PreviewFeature.
▼ ▲ compute.previewFeatures.list
Path : projects/{project}/global/previewFeatures
Flat Path : projects/{project}/global/previewFeatures
HTTP Method : GET
Parameters :
filter
Description : A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your 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 `:*` 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) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq "double quoted literal"` `(fieldname1 eq literal) (fieldname2 ne "literal")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name "instance", you would use `name ne .*instance`. You cannot combine constraints on multiple fields using regular expressions.
Location : query
Type : string
maxResults
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`)
Default : 500
Minimum : 0
Location : query
Type : integer
Format : uint32
orderBy
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
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.
Location : query
Type : string
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])?))
Location : path
Required : Yes
Type : string
returnPartialSuccess
Description : Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.
Location : query
Type : boolean
Parameter Order : project
Scopes :
Description : Returns the details of the given PreviewFeature.
▼ ▲ compute.previewFeatures.update
Path : projects/{project}/global/previewFeatures/{previewFeature}
Flat Path : projects/{project}/global/previewFeatures/{previewFeature}
HTTP Method : PATCH
Parameters :
previewFeature
Description : Name of the PreviewFeature for this request.
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Location : path
Required : Yes
Type : string
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])?))
Location : path
Required : Yes
Type : string
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
Parameter Order :
Scopes :
Description : Patches the given PreviewFeature. This method is used to enable or disable a PreviewFeature.
▼ ▲ compute.reservationSubBlocks.reportFaulty
Path : projects/{project}/zones/{zone}/{parentName}/reservationSubBlocks/{reservationSubBlock}/reportFaulty
Flat Path : projects/{project}/zones/{zone}/{parentName}/reservationSubBlocks/{reservationSubBlock}/reportFaulty
HTTP Method : POST
Parameters :
parentName
Description : The name of the parent reservation and parent block. In the format of reservations/{reservation_name}/reservationBlocks/{reservation_block_name}
Location : path
Required : Yes
Type : string
project
Description : Project ID for this request.
Location : path
Required : Yes
Type : string
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
reservationSubBlock
Description : The name of the reservation subBlock. Name should conform to RFC1035 or be a resource ID.
Location : path
Required : Yes
Type : string
zone
Description : Name of the zone for this request. Zone name should conform to RFC1035.
Location : path
Required : Yes
Type : string
Parameter Order :
Scopes :
Description : Allows customers to report a faulty subBlock.
▼ ▲ compute.organizationSecurityPolicies.list
Path : locations/global/securityPolicies
Flat Path : locations/global/securityPolicies
HTTP Method : GET
Parameters :
filter
Description : A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your 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 `:*` 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) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq "double quoted literal"` `(fieldname1 eq literal) (fieldname2 ne "literal")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name "instance", you would use `name ne .*instance`. You cannot combine constraints on multiple fields using regular expressions.
Location : query
Type : string
maxResults
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`)
Default : 500
Minimum : 0
Location : query
Type : integer
Format : uint32
orderBy
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
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.
Location : query
Type : string
parentId
Description : Parent ID for this request.
Location : query
Type : string
returnPartialSuccess
Description : Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.
Location : query
Type : boolean
Scopes :
Description : List all the policies that have been configured for the specified project. Use of this API to read firewall policies is deprecated. Use firewallPolicies.list instead.
▼ ▲ compute.organizationSecurityPolicies.get
Path : locations/global/securityPolicies/{securityPolicy}
Flat Path : locations/global/securityPolicies/{securityPolicy}
HTTP Method : GET
Parameters :
securityPolicy
Description : Name of the security policy to get.
Pattern : (securityPolicies/)?[0-9]{0,20}
Location : path
Required : Yes
Type : string
Parameter Order : securityPolicy
Scopes :
Description : List all of the ordered rules present in a single specified policy. Use of this API to read firewall policies is deprecated. Use firewallPolicies.get instead.
▼ ▲ compute.organizationSecurityPolicies.insert
Path : locations/global/securityPolicies
Flat Path : locations/global/securityPolicies
HTTP Method : POST
Parameters :
parentId
Description : Parent ID for this request. The ID can be either be "folders/[FOLDER_ID]" if the parent is a folder or "organizations/[ORGANIZATION_ID]" if the parent is an organization.
Location : query
Type : string
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
Scopes :
Description : Creates a new policy in the specified project using the data included in the request. Use of this API to insert firewall policies is deprecated. Use firewallPolicies.insert instead.
▼ ▲ compute.organizationSecurityPolicies.delete
Path : locations/global/securityPolicies/{securityPolicy}
Flat Path : locations/global/securityPolicies/{securityPolicy}
HTTP Method : DELETE
Parameters :
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
securityPolicy
Description : Name of the security policy to delete.
Pattern : (securityPolicies/)?[0-9]{0,20}
Location : path
Required : Yes
Type : string
Parameter Order : securityPolicy
Scopes :
Description : Deletes the specified policy. Use of this API to remove firewall policies is deprecated. Use firewallPolicies.delete instead.
▼ ▲ compute.organizationSecurityPolicies.patch
Path : locations/global/securityPolicies/{securityPolicy}
Flat Path : locations/global/securityPolicies/{securityPolicy}
HTTP Method : PATCH
Parameters :
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
securityPolicy
Description : Name of the security policy to update.
Pattern : (securityPolicies/)?[0-9]{0,20}
Location : path
Required : Yes
Type : string
Parameter Order : securityPolicy
Scopes :
Description : Patches the specified policy with the data included in the request. Use of this API to modify firewall policies is deprecated. Use firewallPolicies.patch instead.
▼ ▲ compute.organizationSecurityPolicies.getRule
Path : locations/global/securityPolicies/{securityPolicy}/getRule
Flat Path : locations/global/securityPolicies/{securityPolicy}/getRule
HTTP Method : GET
Parameters :
priority
Description : The priority of the rule to get from the security policy.
Location : query
Type : integer
Format : int32
securityPolicy
Description : Name of the security policy to which the queried rule belongs.
Pattern : (securityPolicies/)?[0-9]{0,20}
Location : path
Required : Yes
Type : string
Parameter Order : securityPolicy
Scopes :
Description : Gets a rule at the specified priority. Use of this API to read firewall policies is deprecated. Use firewallPolicies.getRule instead.
▼ ▲ compute.organizationSecurityPolicies.addRule
Path : locations/global/securityPolicies/{securityPolicy}/addRule
Flat Path : locations/global/securityPolicies/{securityPolicy}/addRule
HTTP Method : POST
Parameters :
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
securityPolicy
Description : Name of the security policy to update.
Pattern : (securityPolicies/)?[0-9]{0,20}
Location : path
Required : Yes
Type : string
Parameter Order : securityPolicy
Scopes :
Description : Inserts a rule into a security policy.
▼ ▲ compute.organizationSecurityPolicies.removeRule
Path : locations/global/securityPolicies/{securityPolicy}/removeRule
Flat Path : locations/global/securityPolicies/{securityPolicy}/removeRule
HTTP Method : POST
Parameters :
priority
Description : The priority of the rule to remove from the security policy.
Location : query
Type : integer
Format : int32
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
securityPolicy
Description : Name of the security policy to update.
Pattern : (securityPolicies/)?[0-9]{0,20}
Location : path
Required : Yes
Type : string
Parameter Order : securityPolicy
Scopes :
Description : Deletes a rule at the specified priority.
▼ ▲ compute.organizationSecurityPolicies.patchRule
Path : locations/global/securityPolicies/{securityPolicy}/patchRule
Flat Path : locations/global/securityPolicies/{securityPolicy}/patchRule
HTTP Method : POST
Parameters :
priority
Description : The priority of the rule to patch.
Location : query
Type : integer
Format : int32
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
securityPolicy
Description : Name of the security policy to update.
Pattern : (securityPolicies/)?[0-9]{0,20}
Location : path
Required : Yes
Type : string
Parameter Order : securityPolicy
Scopes :
Description : Patches a rule at the specified priority. Use of this API to modify firewall policies is deprecated. Use firewallPolicies.patchRule instead.
▼ ▲ compute.organizationSecurityPolicies.listPreconfiguredExpressionSets
Path : locations/global/securityPolicies/listPreconfiguredExpressionSets
Flat Path : locations/global/securityPolicies/listPreconfiguredExpressionSets
HTTP Method : GET
Parameters :
filter
Description : A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your 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 `:*` 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) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq "double quoted literal"` `(fieldname1 eq literal) (fieldname2 ne "literal")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name "instance", you would use `name ne .*instance`. You cannot combine constraints on multiple fields using regular expressions.
Location : query
Type : string
maxResults
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`)
Default : 500
Minimum : 0
Location : query
Type : integer
Format : uint32
orderBy
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
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.
Location : query
Type : string
parentId
Description : Parent ID for this request.
Location : query
Type : string
returnPartialSuccess
Description : Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.
Location : query
Type : boolean
Scopes :
Description : Gets the current list of preconfigured Web Application Firewall (WAF) expressions.
▼ ▲ compute.organizationSecurityPolicies.addAssociation
Path : locations/global/securityPolicies/{securityPolicy}/addAssociation
Flat Path : locations/global/securityPolicies/{securityPolicy}/addAssociation
HTTP Method : POST
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
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
securityPolicy
Description : Name of the security policy to update.
Pattern : (securityPolicies/)?[0-9]{0,20}
Location : path
Required : Yes
Type : string
Parameter Order : securityPolicy
Scopes :
Description : Inserts an association for the specified security policy. This has billing implications. Projects in the hierarchy with effective hierarchical security policies will be automatically enrolled into Cloud Armor Enterprise if not already enrolled. Use of this API to modify firewall policies is deprecated. Use firewallPolicies.addAssociation instead if possible.
▼ ▲ compute.organizationSecurityPolicies.removeAssociation
Path : locations/global/securityPolicies/{securityPolicy}/removeAssociation
Flat Path : locations/global/securityPolicies/{securityPolicy}/removeAssociation
HTTP Method : POST
Parameters :
name
Description : Name for the attachment that will be removed.
Location : query
Type : string
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
securityPolicy
Description : Name of the security policy to update.
Pattern : (securityPolicies/)?[0-9]{0,20}
Location : path
Required : Yes
Type : string
Parameter Order : securityPolicy
Scopes :
Description : Removes an association for the specified security policy. Use of this API to modify firewall policies is deprecated. Use firewallPolicies.removeAssociation instead if possible.
▼ ▲ compute.organizationSecurityPolicies.listAssociations
Path : locations/global/securityPolicies/listAssociations
Flat Path : locations/global/securityPolicies/listAssociations
HTTP Method : GET
Parameters :
targetResource
Description : The target resource to list associations. It is an organization, or a folder.
Location : query
Type : string
Scopes :
Description : Lists associations of a specified target, i.e., organization or folder. Use of this API to read firewall policies is deprecated. Use firewallPolicies.listAssociations instead if possible.
▼ ▲ compute.organizationSecurityPolicies.getAssociation
Path : locations/global/securityPolicies/{securityPolicy}/getAssociation
Flat Path : locations/global/securityPolicies/{securityPolicy}/getAssociation
HTTP Method : GET
Parameters :
name
Description : The name of the association to get from the security policy.
Location : query
Type : string
securityPolicy
Description : Name of the security policy to which the queried rule belongs.
Pattern : (securityPolicies/)?[0-9]{0,20}
Location : path
Required : Yes
Type : string
Parameter Order : securityPolicy
Scopes :
Description : Gets an association with the specified name. Use of this API to read firewall policies is deprecated. Use firewallPolicies.getAssociation instead if possible.
▼ ▲ compute.organizationSecurityPolicies.copyRules
Path : locations/global/securityPolicies/{securityPolicy}/copyRules
Flat Path : locations/global/securityPolicies/{securityPolicy}/copyRules
HTTP Method : POST
Parameters :
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
securityPolicy
Description : Name of the security policy to update.
Pattern : (securityPolicies/)?[0-9]{0,20}
Location : path
Required : Yes
Type : string
sourceSecurityPolicy
Description : The security policy from which to copy rules.
Location : query
Type : string
Parameter Order : securityPolicy
Scopes :
Description : Copies rules to the specified security policy. Use of this API to modify firewall policies is deprecated. Use firewallPolicies.copyRules instead.
▼ ▲ compute.organizationSecurityPolicies.move
Path : locations/global/securityPolicies/{securityPolicy}/move
Flat Path : locations/global/securityPolicies/{securityPolicy}/move
HTTP Method : POST
Parameters :
parentId
Description : The new parent of the security policy.
Location : query
Type : string
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
securityPolicy
Description : Name of the security policy to update.
Pattern : (securityPolicies/)?[0-9]{0,20}
Location : path
Required : Yes
Type : string
Parameter Order : securityPolicy
Scopes :
Description : Moves the specified security policy. Use of this API to modify firewall policies is deprecated. Use firewallPolicies.move instead.
▼ ▲ compute.backendServices.getEffectiveSecurityPolicies
Path : projects/{project}/global/backendServices/{backendService}/getEffectiveSecurityPolicies
Flat Path : projects/{project}/global/backendServices/{backendService}/getEffectiveSecurityPolicies
HTTP Method : GET
Parameters :
backendService
Description : Name of the Backend Service for this request.
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Location : path
Required : Yes
Type : string
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])?))
Location : path
Required : Yes
Type : string
Parameter Order :
Scopes :
Description : Returns effective security policies applied to this backend service.
▼ ▲ compute.previewFeatures.get
Path : projects/{project}/global/previewFeatures/{previewFeature}
Flat Path : projects/{project}/global/previewFeatures/{previewFeature}
HTTP Method : GET
Parameters :
previewFeature
Description : Name of the PreviewFeature for this request.
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Location : path
Required : Yes
Type : string
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])?))
Location : path
Required : Yes
Type : string
Parameter Order :
Scopes :
Description : Returns the details of the given PreviewFeature.
▼ ▲ compute.previewFeatures.list
Path : projects/{project}/global/previewFeatures
Flat Path : projects/{project}/global/previewFeatures
HTTP Method : GET
Parameters :
filter
Description : A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your 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 `:*` 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) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq "double quoted literal"` `(fieldname1 eq literal) (fieldname2 ne "literal")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name "instance", you would use `name ne .*instance`. You cannot combine constraints on multiple fields using regular expressions.
Location : query
Type : string
maxResults
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`)
Default : 500
Minimum : 0
Location : query
Type : integer
Format : uint32
orderBy
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
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.
Location : query
Type : string
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])?))
Location : path
Required : Yes
Type : string
returnPartialSuccess
Description : Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.
Location : query
Type : boolean
Parameter Order : project
Scopes :
Description : Returns the details of the given PreviewFeature.
▼ ▲ compute.previewFeatures.update
Path : projects/{project}/global/previewFeatures/{previewFeature}
Flat Path : projects/{project}/global/previewFeatures/{previewFeature}
HTTP Method : PATCH
Parameters :
previewFeature
Description : Name of the PreviewFeature for this request.
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Location : path
Required : Yes
Type : string
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])?))
Location : path
Required : Yes
Type : string
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
Parameter Order :
Scopes :
Description : Patches the given PreviewFeature. This method is used to enable or disable a PreviewFeature.
▼ ▲ compute.reservationSubBlocks.reportFaulty
Path : projects/{project}/zones/{zone}/{parentName}/reservationSubBlocks/{reservationSubBlock}/reportFaulty
Flat Path : projects/{project}/zones/{zone}/{parentName}/reservationSubBlocks/{reservationSubBlock}/reportFaulty
HTTP Method : POST
Parameters :
parentName
Description : The name of the parent reservation and parent block. In the format of reservations/{reservation_name}/reservationBlocks/{reservation_block_name}
Location : path
Required : Yes
Type : string
project
Description : Project ID for this request.
Location : path
Required : Yes
Type : string
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
reservationSubBlock
Description : The name of the reservation subBlock. Name should conform to RFC1035 or be a resource ID.
Location : path
Required : Yes
Type : string
zone
Description : Name of the zone for this request. Zone name should conform to RFC1035.
Location : path
Required : Yes
Type : string
Parameter Order :
Scopes :
Description : Allows customers to report a faulty subBlock.