2022-05-17
▼ ▲ compute.sslPolicies.aggregatedList
HTTP Method: GET
Path: projects/{project}/aggregated/sslPolicies
Flat Path: projects/{project}/aggregated/sslPolicies
Parameters:
maxResults
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
Location: query
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
Type: string
Description: Name of the project scoping this request.
Location: path
returnPartialSuccess
Description: Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.
Type: boolean
Location: query
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
orderBy
Location: query
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.
pageToken
Location: query
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
includeAllScopes
Type: boolean
Description: Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included.
Location: query
Parameter Order: project
Description: Retrieves the list of all SslPolicy resources, regional and global, available to the specified project.
Scopes:
▼ ▲ compute.regionSslPolicies.get
Parameter Order:
Flat Path: projects/{project}/regions/{region}/sslPolicies/{sslPolicy}
Parameters:
project
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])?))
Type: string
Location: path
sslPolicy
Type: string
Description: Name of the SSL policy to update. The name must be 1-63 characters long, and comply with RFC1035.
Location: path
Required: Yes
region
Description: Name of the region scoping this request.
Location: path
Type: string
Required: Yes
Pattern: [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Path: projects/{project}/regions/{region}/sslPolicies/{sslPolicy}
Scopes:
Description: Lists all of the ordered rules present in a single specified policy.
HTTP Method: GET
▼ ▲ compute.regionSslPolicies.insert
Parameters:
project
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])?))
Location: path
Type: string
region
Type: string
Description: Name of the region scoping this request.
Required: Yes
Pattern: [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Location: path
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: Creates a new policy in the specified project and region using the data included in the request.
Path: projects/{project}/regions/{region}/sslPolicies
Parameter Order:
Scopes:
HTTP Method: POST
Flat Path: projects/{project}/regions/{region}/sslPolicies
▼ ▲ compute.regionSslPolicies.list
Flat Path: projects/{project}/regions/{region}/sslPolicies
Description: Lists all the SSL policies that have been configured for the specified project and region.
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
Location: query
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
returnPartialSuccess
Location: query
Type: boolean
Description: Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.
region
Type: string
Pattern: [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Description: Name of the region scoping this request.
Required: Yes
Location: path
maxResults
Location: query
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`)
Format: uint32
Minimum: 0
Type: integer
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])?))
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
HTTP Method: GET
Path: projects/{project}/regions/{region}/sslPolicies
Parameter Order:
Scopes:
▼ ▲ compute.regionSslPolicies.testIamPermissions
Parameter Order:
Scopes:
HTTP Method: POST
Parameters:
region
Pattern: [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Required: Yes
Location: path
Type: string
Description: The name of the region for this request.
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
Description: Project ID for this request.
Type: string
Required: Yes
resource
Type: string
Description: Name or id of the resource for this request.
Required: Yes
Location: path
Pattern: [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Path: projects/{project}/regions/{region}/sslPolicies/{resource}/testIamPermissions
Flat Path: projects/{project}/regions/{region}/sslPolicies/{resource}/testIamPermissions
Description: Returns permissions that a caller has on the specified resource.
▼ ▲ compute.regionSslPolicies.listAvailableFeatures
Scopes:
Parameter Order:
Path: projects/{project}/regions/{region}/sslPolicies/listAvailableFeatures
Flat Path: projects/{project}/regions/{region}/sslPolicies/listAvailableFeatures
Parameters:
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.
Type: string
Location: query
filter
Type: string
Location: query
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) ```
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
maxResults
Default: 500
Format: uint32
Minimum: 0
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`)
Type: integer
pageToken
Type: string
Location: query
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.
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.
Required: Yes
Location: path
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
Description: Lists all features that can be specified in the SSL policy when using custom profile.
HTTP Method: GET
▼ ▲ compute.regionSslPolicies.delete
Scopes:
Parameter Order:
Parameters:
sslPolicy
Location: path
Type: string
Required: Yes
Description: Name of the SSL policy to delete. The name must be 1-63 characters long, and comply with RFC1035.
project
Type: string
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.
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
Description: Name of the region scoping this request.
Required: Yes
Type: string
Location: path
Pattern: [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
HTTP Method: DELETE
Description: Deletes the specified SSL policy. The SSL policy resource can be deleted only if it is not in use by any TargetHttpsProxy or TargetSslProxy resources.
Path: projects/{project}/regions/{region}/sslPolicies/{sslPolicy}
Flat Path: projects/{project}/regions/{region}/sslPolicies/{sslPolicy}
▼ ▲ compute.regionSslPolicies.patch
Parameter Order:
Parameters:
project
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])?))
Type: string
sslPolicy
Location: path
Required: Yes
Type: string
Description: Name of the SSL policy to update. The name must be 1-63 characters long, and comply with RFC1035.
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
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
HTTP Method: PATCH
Description: Patches the specified SSL policy with the data included in the request.
Scopes:
Path: projects/{project}/regions/{region}/sslPolicies/{sslPolicy}
Flat Path: projects/{project}/regions/{region}/sslPolicies/{sslPolicy}