SmartWebSecurity API, gRPC: SecurityProfileService
A set of methods for managing SecurityProfile resources.
Call | Description |
---|---|
Get | Returns the specified SecurityProfile resource. |
List | Retrieves the list of SecurityProfile resources in the specified folder. |
Create | Creates a security profile in the specified folder using the data specified in the request. |
Update | Updates the specified security profile. |
Delete | Deletes the specified security profile. |
Calls SecurityProfileService
Get
Returns the specified SecurityProfile resource.
rpc Get (GetSecurityProfileRequest) returns (SecurityProfile)
GetSecurityProfileRequest
Field | Description |
---|---|
security_profile_id | string Required. ID of the SecurityProfile resource to return. |
SecurityProfile
Field | Description |
---|---|
id | string ID of the security profile. |
folder_id | string ID of the folder that the security profile belongs to. |
labels | map<string,string> Labels as key:value pairs. Maximum of 64 per resource. No more than 64 per resource. The maximum string length in characters for each value is 63. Each value must match the regular expression [-_0-9a-z]* . The string length in characters for each key must be 1-63. Each key must match the regular expression [a-z][-_0-9a-z]* . |
name | string Required. Name of the security profile. The name is unique within the folder. 1-50 characters long. The string length in characters must be 1-50. Value must match the regular expression [a-zA-Z0-9][a-zA-Z0-9-_.]* . |
description | string Optional description of the security profile. The maximum string length in characters is 512. |
default_action | enum DefaultAction Required. Action to perform if none of rules matched.
|
security_rules[] | SecurityRule List of security rules. |
created_at | google.protobuf.Timestamp Creation timestamp in RFC3339 |
cloud_id | string ID of the cloud that the security profile belongs to. |
captcha_id | string Captcha ID to use with this security profile. Set empty to use default. |
advanced_rate_limiter_profile_id | string Advanced rate limiter profile ID to use with this security profile. Set empty to use default. |
SecurityRule
Field | Description |
---|---|
name | string Required. Name of the rule. The name is unique within the security profile. 1-50 characters long. The string length in characters must be 1-50. Value must match the regular expression [a-zA-Z0-9][a-zA-Z0-9-_.]* . |
priority | int64 Determines the priority for checking the incoming traffic. Enter an integer within the range of 1 and 999999. The rule priority must be unique within the entire security profile. A lower numeric value means a higher priority. The default_action has the lowest priority. Acceptable values are 1 to 999999, inclusive. |
dry_run | bool This mode allows you to test your security profile or a single rule. For example, you can have the number of alarms for a specific rule displayed. Note: if this option is true, no real action affecting your traffic regarding this rule will be taken. |
rule_specifier | oneof: rule_condition , smart_protection or waf |
rule_condition | RuleCondition Rule actions, see Rule actions. |
smart_protection | SmartProtection Smart Protection rule, see Smart Protection rules. |
waf | Waf Web Application Firewall (WAF) rule, see WAF rules. |
description | string Optional description of the rule. 0-512 characters long. The maximum string length in characters is 512. |
RuleCondition
Field | Description |
---|---|
action | enum Action Action to perform if this rule matched.
|
condition | Condition The condition for matching the rule. |
SmartProtection
Field | Description |
---|---|
mode | enum Mode Mode of protection.
|
condition | Condition The condition for matching the rule. |
Waf
Field | Description |
---|---|
mode | enum Mode Mode of protection.
|
condition | Condition The condition for matching the rule. |
waf_profile_id | string Required. ID of WAF profile to use in this rule. |
Condition
Field | Description |
---|---|
authority | AuthorityMatcher Match authority (Host header). |
http_method | HttpMethodMatcher Match HTTP method. |
request_uri | RequestUriMatcher Match Request URI. |
headers[] | HeaderMatcher Match HTTP headers. The maximum number of elements is 20. |
source_ip | IpMatcher Match IP. |
StringMatcher
Field | Description |
---|---|
match | oneof: exact_match , exact_not_match , prefix_match , prefix_not_match , pire_regex_match or pire_regex_not_match |
exact_match | string The string length in characters must be 0-255. |
exact_not_match | string The string length in characters must be 0-255. |
prefix_match | string The string length in characters must be 0-255. |
prefix_not_match | string The string length in characters must be 0-255. |
pire_regex_match | string The string length in characters must be 0-255. |
pire_regex_not_match | string The string length in characters must be 0-255. |
HttpMethodMatcher
Field | Description |
---|---|
http_methods[] | StringMatcher List of HTTP methods. OR semantics implied. The maximum number of elements is 20. |
AuthorityMatcher
Field | Description |
---|---|
authorities[] | StringMatcher List of authorities. OR semantics implied. The maximum number of elements is 20. |
RequestUriMatcher
Field | Description |
---|---|
path | StringMatcher Path of the URI RFC3986 |
queries[] | QueryMatcher List of query matchers. AND semantics implied. The maximum number of elements is 20. |
QueryMatcher
Field | Description |
---|---|
key | string Required. Key of the query parameter. The string length in characters must be 1-255. |
value | StringMatcher Required. Value of the query parameter. |
HeaderMatcher
Field | Description |
---|---|
name | string Required. Name of header (case insensitive). The string length in characters must be 1-255. |
value | StringMatcher Required. Value of the header. |
IpMatcher
Field | Description |
---|---|
ip_ranges_match | IpRangesMatcher |
ip_ranges_not_match | IpRangesMatcher |
geo_ip_match | GeoIpMatcher |
geo_ip_not_match | GeoIpMatcher |
IpRangesMatcher
Field | Description |
---|---|
ip_ranges[] | string List of IP ranges. OR semantics implied. The maximum number of elements is 10000. |
GeoIpMatcher
Field | Description |
---|---|
locations[] | string ISO 3166-1 alpha 2. OR semantics implied. The minimum number of elements is 1. The string length in characters for each value must be equal to 2. |
List
Retrieves the list of SecurityProfile resources in the specified folder.
rpc List (ListSecurityProfilesRequest) returns (ListSecurityProfilesResponse)
ListSecurityProfilesRequest
Field | Description |
---|---|
folder_id | string Required. ID of the folder that the security profile belongs to. Currently page_size, page_token, filter and order_by are not supported and List method will return all security profiles in the folder. |
ListSecurityProfilesResponse
Field | Description |
---|---|
security_profiles[] | SecurityProfile List of SecurityProfile resources. Currently next_page_token is not supported and List method will return all security profiles in the folder. |
SecurityProfile
Field | Description |
---|---|
id | string ID of the security profile. |
folder_id | string ID of the folder that the security profile belongs to. |
labels | map<string,string> Labels as key:value pairs. Maximum of 64 per resource. No more than 64 per resource. The maximum string length in characters for each value is 63. Each value must match the regular expression [-_0-9a-z]* . The string length in characters for each key must be 1-63. Each key must match the regular expression [a-z][-_0-9a-z]* . |
name | string Required. Name of the security profile. The name is unique within the folder. 1-50 characters long. The string length in characters must be 1-50. Value must match the regular expression [a-zA-Z0-9][a-zA-Z0-9-_.]* . |
description | string Optional description of the security profile. The maximum string length in characters is 512. |
default_action | enum DefaultAction Required. Action to perform if none of rules matched.
|
security_rules[] | SecurityRule List of security rules. |
created_at | google.protobuf.Timestamp Creation timestamp in RFC3339 |
cloud_id | string ID of the cloud that the security profile belongs to. |
captcha_id | string Captcha ID to use with this security profile. Set empty to use default. |
advanced_rate_limiter_profile_id | string Advanced rate limiter profile ID to use with this security profile. Set empty to use default. |
SecurityRule
Field | Description |
---|---|
name | string Required. Name of the rule. The name is unique within the security profile. 1-50 characters long. The string length in characters must be 1-50. Value must match the regular expression [a-zA-Z0-9][a-zA-Z0-9-_.]* . |
priority | int64 Determines the priority for checking the incoming traffic. Enter an integer within the range of 1 and 999999. The rule priority must be unique within the entire security profile. A lower numeric value means a higher priority. The default_action has the lowest priority. Acceptable values are 1 to 999999, inclusive. |
dry_run | bool This mode allows you to test your security profile or a single rule. For example, you can have the number of alarms for a specific rule displayed. Note: if this option is true, no real action affecting your traffic regarding this rule will be taken. |
rule_specifier | oneof: rule_condition , smart_protection or waf |
rule_condition | RuleCondition Rule actions, see Rule actions. |
smart_protection | SmartProtection Smart Protection rule, see Smart Protection rules. |
waf | Waf Web Application Firewall (WAF) rule, see WAF rules. |
description | string Optional description of the rule. 0-512 characters long. The maximum string length in characters is 512. |
RuleCondition
Field | Description |
---|---|
action | enum Action Action to perform if this rule matched.
|
condition | Condition The condition for matching the rule. |
SmartProtection
Field | Description |
---|---|
mode | enum Mode Mode of protection.
|
condition | Condition The condition for matching the rule. |
Waf
Field | Description |
---|---|
mode | enum Mode Mode of protection.
|
condition | Condition The condition for matching the rule. |
waf_profile_id | string Required. ID of WAF profile to use in this rule. |
Condition
Field | Description |
---|---|
authority | AuthorityMatcher Match authority (Host header). |
http_method | HttpMethodMatcher Match HTTP method. |
request_uri | RequestUriMatcher Match Request URI. |
headers[] | HeaderMatcher Match HTTP headers. The maximum number of elements is 20. |
source_ip | IpMatcher Match IP. |
StringMatcher
Field | Description |
---|---|
match | oneof: exact_match , exact_not_match , prefix_match , prefix_not_match , pire_regex_match or pire_regex_not_match |
exact_match | string The string length in characters must be 0-255. |
exact_not_match | string The string length in characters must be 0-255. |
prefix_match | string The string length in characters must be 0-255. |
prefix_not_match | string The string length in characters must be 0-255. |
pire_regex_match | string The string length in characters must be 0-255. |
pire_regex_not_match | string The string length in characters must be 0-255. |
HttpMethodMatcher
Field | Description |
---|---|
http_methods[] | StringMatcher List of HTTP methods. OR semantics implied. The maximum number of elements is 20. |
AuthorityMatcher
Field | Description |
---|---|
authorities[] | StringMatcher List of authorities. OR semantics implied. The maximum number of elements is 20. |
RequestUriMatcher
Field | Description |
---|---|
path | StringMatcher Path of the URI RFC3986 |
queries[] | QueryMatcher List of query matchers. AND semantics implied. The maximum number of elements is 20. |
QueryMatcher
Field | Description |
---|---|
key | string Required. Key of the query parameter. The string length in characters must be 1-255. |
value | StringMatcher Required. Value of the query parameter. |
HeaderMatcher
Field | Description |
---|---|
name | string Required. Name of header (case insensitive). The string length in characters must be 1-255. |
value | StringMatcher Required. Value of the header. |
IpMatcher
Field | Description |
---|---|
ip_ranges_match | IpRangesMatcher |
ip_ranges_not_match | IpRangesMatcher |
geo_ip_match | GeoIpMatcher |
geo_ip_not_match | GeoIpMatcher |
IpRangesMatcher
Field | Description |
---|---|
ip_ranges[] | string List of IP ranges. OR semantics implied. The maximum number of elements is 10000. |
GeoIpMatcher
Field | Description |
---|---|
locations[] | string ISO 3166-1 alpha 2. OR semantics implied. The minimum number of elements is 1. The string length in characters for each value must be equal to 2. |
Create
Creates a security profile in the specified folder using the data specified in the request.
rpc Create (CreateSecurityProfileRequest) returns (operation.Operation)
Metadata and response of Operation:
Operation.metadata:CreateSecurityProfileMetadata
Operation.response:SecurityProfile
CreateSecurityProfileRequest
Field | Description |
---|---|
folder_id | string Required. ID of the folder to create a security profile in. |
labels | map<string,string> Labels as key:value pairs. Maximum of 64 per resource. |
name | string Name of the security profile. The name is unique within the folder. 1-50 characters long. |
description | string Optional description of the security profile. |
default_action | SecurityProfile.DefaultAction Action to perform if none of rules matched. |
security_rules[] | SecurityRule List of security rules. |
captcha_id | string Captcha ID to use with this security profile. Set empty to use default. |
advanced_rate_limiter_profile_id | string Advanced rate limiter profile ID to use with this security profile. Set empty to use default. |
SecurityRule
Field | Description |
---|---|
name | string Required. Name of the rule. The name is unique within the security profile. 1-50 characters long. The string length in characters must be 1-50. Value must match the regular expression [a-zA-Z0-9][a-zA-Z0-9-_.]* . |
priority | int64 Determines the priority for checking the incoming traffic. Enter an integer within the range of 1 and 999999. The rule priority must be unique within the entire security profile. A lower numeric value means a higher priority. The default_action has the lowest priority. Acceptable values are 1 to 999999, inclusive. |
dry_run | bool This mode allows you to test your security profile or a single rule. For example, you can have the number of alarms for a specific rule displayed. Note: if this option is true, no real action affecting your traffic regarding this rule will be taken. |
rule_specifier | oneof: rule_condition , smart_protection or waf |
rule_condition | RuleCondition Rule actions, see Rule actions. |
smart_protection | SmartProtection Smart Protection rule, see Smart Protection rules. |
waf | Waf Web Application Firewall (WAF) rule, see WAF rules. |
description | string Optional description of the rule. 0-512 characters long. The maximum string length in characters is 512. |
RuleCondition
Field | Description |
---|---|
action | enum Action Action to perform if this rule matched.
|
condition | Condition The condition for matching the rule. |
SmartProtection
Field | Description |
---|---|
mode | enum Mode Mode of protection.
|
condition | Condition The condition for matching the rule. |
Waf
Field | Description |
---|---|
mode | enum Mode Mode of protection.
|
condition | Condition The condition for matching the rule. |
waf_profile_id | string Required. ID of WAF profile to use in this rule. |
Condition
Field | Description |
---|---|
authority | AuthorityMatcher Match authority (Host header). |
http_method | HttpMethodMatcher Match HTTP method. |
request_uri | RequestUriMatcher Match Request URI. |
headers[] | HeaderMatcher Match HTTP headers. The maximum number of elements is 20. |
source_ip | IpMatcher Match IP. |
StringMatcher
Field | Description |
---|---|
match | oneof: exact_match , exact_not_match , prefix_match , prefix_not_match , pire_regex_match or pire_regex_not_match |
exact_match | string The string length in characters must be 0-255. |
exact_not_match | string The string length in characters must be 0-255. |
prefix_match | string The string length in characters must be 0-255. |
prefix_not_match | string The string length in characters must be 0-255. |
pire_regex_match | string The string length in characters must be 0-255. |
pire_regex_not_match | string The string length in characters must be 0-255. |
HttpMethodMatcher
Field | Description |
---|---|
http_methods[] | StringMatcher List of HTTP methods. OR semantics implied. The maximum number of elements is 20. |
AuthorityMatcher
Field | Description |
---|---|
authorities[] | StringMatcher List of authorities. OR semantics implied. The maximum number of elements is 20. |
RequestUriMatcher
Field | Description |
---|---|
path | StringMatcher Path of the URI RFC3986 |
queries[] | QueryMatcher List of query matchers. AND semantics implied. The maximum number of elements is 20. |
QueryMatcher
Field | Description |
---|---|
key | string Required. Key of the query parameter. The string length in characters must be 1-255. |
value | StringMatcher Required. Value of the query parameter. |
HeaderMatcher
Field | Description |
---|---|
name | string Required. Name of header (case insensitive). The string length in characters must be 1-255. |
value | StringMatcher Required. Value of the header. |
IpMatcher
Field | Description |
---|---|
ip_ranges_match | IpRangesMatcher |
ip_ranges_not_match | IpRangesMatcher |
geo_ip_match | GeoIpMatcher |
geo_ip_not_match | GeoIpMatcher |
IpRangesMatcher
Field | Description |
---|---|
ip_ranges[] | string List of IP ranges. OR semantics implied. The maximum number of elements is 10000. |
GeoIpMatcher
Field | Description |
---|---|
locations[] | string ISO 3166-1 alpha 2. OR semantics implied. The minimum number of elements is 1. The string length in characters for each value must be equal to 2. |
Operation
Field | Description |
---|---|
id | string ID of the operation. |
description | string Description of the operation. 0-256 characters long. |
created_at | google.protobuf.Timestamp Creation timestamp. |
created_by | string ID of the user or service account who initiated the operation. |
modified_at | google.protobuf.Timestamp The time when the Operation resource was last modified. |
done | bool If the value is false , it means the operation is still in progress. If true , the operation is completed, and either error or response is available. |
metadata | google.protobuf.Any Service-specific metadata associated with the operation. It typically contains the ID of the target resource that the operation is performed on. Any method that returns a long-running operation should document the metadata type, if any. |
result | oneof: error or response The operation result. If done == false and there was no failure detected, neither error nor response is set. If done == false and there was a failure detected, error is set. If done == true , exactly one of error or response is set. |
error | google.rpc.Status The error result of the operation in case of failure or cancellation. |
response | google.protobuf.Any if operation finished successfully. |
CreateSecurityProfileMetadata
Field | Description |
---|---|
security_profile_id | string ID of the security profile that is being created. |
SecurityProfile
Field | Description |
---|---|
id | string ID of the security profile. |
folder_id | string ID of the folder that the security profile belongs to. |
labels | map<string,string> Labels as key:value pairs. Maximum of 64 per resource. No more than 64 per resource. The maximum string length in characters for each value is 63. Each value must match the regular expression [-_0-9a-z]* . The string length in characters for each key must be 1-63. Each key must match the regular expression [a-z][-_0-9a-z]* . |
name | string Required. Name of the security profile. The name is unique within the folder. 1-50 characters long. The string length in characters must be 1-50. Value must match the regular expression [a-zA-Z0-9][a-zA-Z0-9-_.]* . |
description | string Optional description of the security profile. The maximum string length in characters is 512. |
default_action | enum DefaultAction Required. Action to perform if none of rules matched.
|
security_rules[] | SecurityRule List of security rules. |
created_at | google.protobuf.Timestamp Creation timestamp in RFC3339 |
cloud_id | string ID of the cloud that the security profile belongs to. |
captcha_id | string Captcha ID to use with this security profile. Set empty to use default. |
advanced_rate_limiter_profile_id | string Advanced rate limiter profile ID to use with this security profile. Set empty to use default. |
Update
Updates the specified security profile.
rpc Update (UpdateSecurityProfileRequest) returns (operation.Operation)
Metadata and response of Operation:
Operation.metadata:UpdateSecurityProfileMetadata
Operation.response:SecurityProfile
UpdateSecurityProfileRequest
Field | Description |
---|---|
security_profile_id | string Required. ID of the security profile to update. |
update_mask | google.protobuf.FieldMask Field mask that specifies which fields of the SecurityProfile resource are going to be updated. |
labels | map<string,string> Labels as key:value pairs. Maximum of 64 per resource. |
name | string Name of the security profile. The name is unique within the folder. 1-50 characters long. |
description | string Optional description of the security profile. |
default_action | SecurityProfile.DefaultAction Action to perform if none of rules matched. |
security_rules[] | SecurityRule List of security rules. |
captcha_id | string Captcha ID to use with this security profile. Set empty to use default. |
advanced_rate_limiter_profile_id | string Advanced rate limiter profile ID to use with this security profile. Set empty to use default. |
SecurityRule
Field | Description |
---|---|
name | string Required. Name of the rule. The name is unique within the security profile. 1-50 characters long. The string length in characters must be 1-50. Value must match the regular expression [a-zA-Z0-9][a-zA-Z0-9-_.]* . |
priority | int64 Determines the priority for checking the incoming traffic. Enter an integer within the range of 1 and 999999. The rule priority must be unique within the entire security profile. A lower numeric value means a higher priority. The default_action has the lowest priority. Acceptable values are 1 to 999999, inclusive. |
dry_run | bool This mode allows you to test your security profile or a single rule. For example, you can have the number of alarms for a specific rule displayed. Note: if this option is true, no real action affecting your traffic regarding this rule will be taken. |
rule_specifier | oneof: rule_condition , smart_protection or waf |
rule_condition | RuleCondition Rule actions, see Rule actions. |
smart_protection | SmartProtection Smart Protection rule, see Smart Protection rules. |
waf | Waf Web Application Firewall (WAF) rule, see WAF rules. |
description | string Optional description of the rule. 0-512 characters long. The maximum string length in characters is 512. |
RuleCondition
Field | Description |
---|---|
action | enum Action Action to perform if this rule matched.
|
condition | Condition The condition for matching the rule. |
SmartProtection
Field | Description |
---|---|
mode | enum Mode Mode of protection.
|
condition | Condition The condition for matching the rule. |
Waf
Field | Description |
---|---|
mode | enum Mode Mode of protection.
|
condition | Condition The condition for matching the rule. |
waf_profile_id | string Required. ID of WAF profile to use in this rule. |
Condition
Field | Description |
---|---|
authority | AuthorityMatcher Match authority (Host header). |
http_method | HttpMethodMatcher Match HTTP method. |
request_uri | RequestUriMatcher Match Request URI. |
headers[] | HeaderMatcher Match HTTP headers. The maximum number of elements is 20. |
source_ip | IpMatcher Match IP. |
StringMatcher
Field | Description |
---|---|
match | oneof: exact_match , exact_not_match , prefix_match , prefix_not_match , pire_regex_match or pire_regex_not_match |
exact_match | string The string length in characters must be 0-255. |
exact_not_match | string The string length in characters must be 0-255. |
prefix_match | string The string length in characters must be 0-255. |
prefix_not_match | string The string length in characters must be 0-255. |
pire_regex_match | string The string length in characters must be 0-255. |
pire_regex_not_match | string The string length in characters must be 0-255. |
HttpMethodMatcher
Field | Description |
---|---|
http_methods[] | StringMatcher List of HTTP methods. OR semantics implied. The maximum number of elements is 20. |
AuthorityMatcher
Field | Description |
---|---|
authorities[] | StringMatcher List of authorities. OR semantics implied. The maximum number of elements is 20. |
RequestUriMatcher
Field | Description |
---|---|
path | StringMatcher Path of the URI RFC3986 |
queries[] | QueryMatcher List of query matchers. AND semantics implied. The maximum number of elements is 20. |
QueryMatcher
Field | Description |
---|---|
key | string Required. Key of the query parameter. The string length in characters must be 1-255. |
value | StringMatcher Required. Value of the query parameter. |
HeaderMatcher
Field | Description |
---|---|
name | string Required. Name of header (case insensitive). The string length in characters must be 1-255. |
value | StringMatcher Required. Value of the header. |
IpMatcher
Field | Description |
---|---|
ip_ranges_match | IpRangesMatcher |
ip_ranges_not_match | IpRangesMatcher |
geo_ip_match | GeoIpMatcher |
geo_ip_not_match | GeoIpMatcher |
IpRangesMatcher
Field | Description |
---|---|
ip_ranges[] | string List of IP ranges. OR semantics implied. The maximum number of elements is 10000. |
GeoIpMatcher
Field | Description |
---|---|
locations[] | string ISO 3166-1 alpha 2. OR semantics implied. The minimum number of elements is 1. The string length in characters for each value must be equal to 2. |
Operation
Field | Description |
---|---|
id | string ID of the operation. |
description | string Description of the operation. 0-256 characters long. |
created_at | google.protobuf.Timestamp Creation timestamp. |
created_by | string ID of the user or service account who initiated the operation. |
modified_at | google.protobuf.Timestamp The time when the Operation resource was last modified. |
done | bool If the value is false , it means the operation is still in progress. If true , the operation is completed, and either error or response is available. |
metadata | google.protobuf.Any Service-specific metadata associated with the operation. It typically contains the ID of the target resource that the operation is performed on. Any method that returns a long-running operation should document the metadata type, if any. |
result | oneof: error or response The operation result. If done == false and there was no failure detected, neither error nor response is set. If done == false and there was a failure detected, error is set. If done == true , exactly one of error or response is set. |
error | google.rpc.Status The error result of the operation in case of failure or cancellation. |
response | google.protobuf.Any if operation finished successfully. |
UpdateSecurityProfileMetadata
Field | Description |
---|---|
security_profile_id | string ID of the SecurityProfile resource that is being updated. |
SecurityProfile
Field | Description |
---|---|
id | string ID of the security profile. |
folder_id | string ID of the folder that the security profile belongs to. |
labels | map<string,string> Labels as key:value pairs. Maximum of 64 per resource. No more than 64 per resource. The maximum string length in characters for each value is 63. Each value must match the regular expression [-_0-9a-z]* . The string length in characters for each key must be 1-63. Each key must match the regular expression [a-z][-_0-9a-z]* . |
name | string Required. Name of the security profile. The name is unique within the folder. 1-50 characters long. The string length in characters must be 1-50. Value must match the regular expression [a-zA-Z0-9][a-zA-Z0-9-_.]* . |
description | string Optional description of the security profile. The maximum string length in characters is 512. |
default_action | enum DefaultAction Required. Action to perform if none of rules matched.
|
security_rules[] | SecurityRule List of security rules. |
created_at | google.protobuf.Timestamp Creation timestamp in RFC3339 |
cloud_id | string ID of the cloud that the security profile belongs to. |
captcha_id | string Captcha ID to use with this security profile. Set empty to use default. |
advanced_rate_limiter_profile_id | string Advanced rate limiter profile ID to use with this security profile. Set empty to use default. |
Delete
Deletes the specified security profile.
rpc Delete (DeleteSecurityProfileRequest) returns (operation.Operation)
Metadata and response of Operation:
Operation.metadata:DeleteSecurityProfileMetadata
Operation.response:google.protobuf.Empty
DeleteSecurityProfileRequest
Field | Description |
---|---|
security_profile_id | string Required. ID of the security profile to delete. |
Operation
Field | Description |
---|---|
id | string ID of the operation. |
description | string Description of the operation. 0-256 characters long. |
created_at | google.protobuf.Timestamp Creation timestamp. |
created_by | string ID of the user or service account who initiated the operation. |
modified_at | google.protobuf.Timestamp The time when the Operation resource was last modified. |
done | bool If the value is false , it means the operation is still in progress. If true , the operation is completed, and either error or response is available. |
metadata | google.protobuf.Any Service-specific metadata associated with the operation. It typically contains the ID of the target resource that the operation is performed on. Any method that returns a long-running operation should document the metadata type, if any. |
result | oneof: error or response The operation result. If done == false and there was no failure detected, neither error nor response is set. If done == false and there was a failure detected, error is set. If done == true , exactly one of error or response is set. |
error | google.rpc.Status The error result of the operation in case of failure or cancellation. |
response | google.protobuf.Any if operation finished successfully. |
DeleteSecurityProfileMetadata
Field | Description |
---|---|
security_profile_id | string ID of the SecurityProfile resource that is being deleted. |