REST Resource: sslPolicies

• Resource: SslPolicy
  • JSON representation
    • JSON representation
• Methods

Resource: SslPolicy

Represents a Cloud Armor Security Policy resource.

Only external backend services used by HTTP or HTTPS load balancers can reference a Security Policy. For more information, read read Cloud Armor Security Policy Concepts.

JSON representation
{ "id": string, "creationTimestamp": string, "selfLink": string, "name": string, "description": string, "profile": enum, "minTlsVersion": enum, "enabledFeatures": [ string ], "customFeatures": [ string ], "fingerprint": string, "warnings": [ { "code": enum, "message": string, "data": [ { "key": string, "value": string } ] } ], "kind": string }

Fields
id	string (fixed64 format) [Output Only] The unique identifier for the resource. This identifier is defined by the server.
creationTimestamp	string [Output Only] Creation timestamp in RFC3339 text format.
selfLink	string [Output Only] Server-defined URL for the resource.
name	string Name of the resource. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
description	string An optional description of this resource. Provide this property when you create the resource.
profile	enum Profile specifies the set of SSL features that can be used by the load balancer when negotiating SSL with clients. This can be one of COMPATIBLE, MODERN, RESTRICTED, or CUSTOM. If using CUSTOM, the set of SSL features to enable must be specified in the customFeatures field.
minTlsVersion	enum The minimum version of SSL protocol that can be used by the clients to establish a connection with the load balancer. This can be one of TLS_1_0, TLS_1_1, TLS_1_2.
enabledFeatures[]	string [Output Only] The list of features enabled in the SSL policy.
customFeatures[]	string A list of features enabled when the selected profile is CUSTOM. The method returns the set of features that can be specified in this list. This field must be empty if the profile is not CUSTOM.
fingerprint	string (bytes format) Fingerprint of this resource. A hash of the contents stored in this object. This field is used in optimistic locking. This field will be ignored when inserting a SslPolicy. An up-to-date fingerprint must be provided in order to update the SslPolicy, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve an SslPolicy. A base64-encoded string.
warnings[]	object [Output Only] If potential misconfigurations are detected for this SSL policy, this field will be populated with warning messages.
warnings[].code	enum [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
warnings[].message	string [Output Only] A human-readable description of the warning code.
warnings[].data[]	object [Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" }
warnings[].data[].key	string [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
warnings[].data[].value	string [Output Only] A warning data value corresponding to the key.
kind	string [Output only] Type of the resource. Always compute#sslPolicyfor SSL policies.

Methods
delete	Deletes the specified SSL policy.
get	Lists all of the ordered rules present in a single specified policy.
insert	Returns the specified SSL policy resource.
list	Lists all the SSL policies that have been configured for the specified project.
listAvailableFeatures	Lists all features that can be specified in the SSL policy when using custom profile.
patch	Patches the specified SSL policy with the data included in the request.