Smart Web Security Load Balancer API, REST: Domain.Update

Field

Description

loadBalancerId

string

Required field. ID of the Load balancer that the domain belongs to.

name

string

Required field. Name of domain that is being updated.

Field

Description

updateMask

string (field-mask)

A comma-separated names off ALL fields to be updated.
Only the specified fields will be changed. The others will be left untouched.
If the field is specified in updateMask and no value for that field was sent in the request,
the field's value will be reset to the default. The default value for most fields is null or 0.

If updateMask is not sent in the request, all fields' values will be updated.
Fields specified in the request will be updated to provided values.
The rest of the fields will be reset to the default.

serverName

string

Required field. Server name or wildcard to be matched against SNI in a TLS connection and authority(host) header.
Wildcards are in the form of ".s.o.m.e".
Allowed: "example.com", ".example.com".
Not allowed: "..example.com", "*-sub.example.com".

The string length in characters must be 1-255.

description

string

Domain description

The maximum string length in characters is 512.

securityProfileId

string

Security Profile ID of SmartWebSecurity service.

httpBackend

HttpBackend

Backend settings.

tlsListener

TlsListener

Optional TLS listener settings.

httpListener

HttpListener

Optional plaintext listener settings.

solidWafSettings

SolidWafSettings

Optional Solid WAF settings.

rateLimit

RateLimit

Optional rate limit settings.

Field

Description

targets[]

Target

List of targets.

The number of elements must be in the range 1-20.

useHttp2

boolean

Enables HTTP2 for upstream requests.
If not set, HTTP 1.1 will be used by default.

useTls

boolean

Enable TLS for upstream requests.

sni

string

SNI string for TLS connections.
Applicable only if use_tls enabled.

The maximum string length in characters is 255. Value must match the regular expression [-.a-z0-9]*.

trustedCaBytes

string

Trusted certificate authority certificates bundle (PEM text).
Applicable only if use_tls enabled.

timeout

string (duration)

Backend timeout. If not set, default is 300 seconds.

idleTimeout

string (duration)

Specifies the idle timeout for the route. If not specified, there is no per-route idle timeout.

sessionAffinity

SessionAffinity

Session affinity.

Field

Description

ipAddress

string

IPv4 address.

The string length in characters must be 1-40.

description

string

Target description.

The maximum string length in characters is 128.

port

string (int64)

Target port.

Acceptable values are 1 to 65535, inclusive.

Field

Description

connection

ConnectionSessionAffinity

Session affinity based on source IP address.

Includes only one of the fields connection, header, cookie.

header

HeaderSessionAffinity

Session affinity based on an HTTP header.

Includes only one of the fields connection, header, cookie.

cookie

CookieSessionAffinity

Session affinity based on a cookie.

Includes only one of the fields connection, header, cookie.

Field

Description

sourceIp

boolean

IP address.

Field

Description

headerName

string

Header name.

The string length in characters must be 1-256.

Field

Description

name

string

Cookie name.

The string length in characters must be 1-256.

ttl

string (duration)

If not set, session cookie will be used (not persisted between browser restarts).

path

string

Optional cookie path.

The string length in characters must be 0-256.

Field

Description

enabled

boolean

Enable TLS listener.

certificateId

string

Certificate ID in the Certificate Manager.

port

string (int64)

Listener port. If value is not set, used 443 by default.

Acceptable values are 0 to 65535, inclusive.

enableHttp1

boolean

Enables HTTP/1.0 and HTTP/1.1 support and disables HTTP/2.

Field

Description

enabled

boolean

Enable http (plaintext) listener.

redirectToHttps

boolean

Automatically redirect from HTTP to HTTPS.
If TlsListener's port is 443 or not set, redirect URL will be "https://<host><path>" and "https://<host>:<port><path>" in other case.

port

string (int64)

Listener port. If value is not set, used 80 by default.

Acceptable values are 0 to 65535, inclusive.

Field

Description

solidWafProfileId

string

ID of the Solid WAF profile.

sessionAffinity

SessionAffinity

Session affinity to analyzers. If not set, ConnectionSessionAffinity will be used.

webAppId

string

ID of the Solid WAF web app.

Field

Description

allRequestsPerSecond

string (int64)

Rate limit for all requests.
Defaults:

• with SolidWaf enabled: 20000 RPS
• without SolidWaf enabled: unlimited

The minimum value is 0.

requestsPerIpPerSecond

string (int64)

Rate limit for individual IP addresses.
Defaults:

• with SolidWaf enabled: 1000 RPS
• without SolidWaf enabled: unlimited

The minimum value is 0.

Field

Description

id

string

ID of the operation.

description

string

Description of the operation. 0-256 characters long.

createdAt

string (date-time)

Creation timestamp.

String in RFC3339 text format. The range of possible values is from
0001-01-01T00:00:00Z to 9999-12-31T23:59:59.999999999Z, i.e. from 0 to 9 digits for fractions of a second.

To work with values in this field, use the APIs described in the
Protocol Buffers reference.
In some languages, built-in datetime utilities do not support nanosecond precision (9 digits).

createdBy

string

ID of the user or service account who initiated the operation.

modifiedAt

string (date-time)

The time when the Operation resource was last modified.

String in RFC3339 text format. The range of possible values is from
0001-01-01T00:00:00Z to 9999-12-31T23:59:59.999999999Z, i.e. from 0 to 9 digits for fractions of a second.

To work with values in this field, use the APIs described in the
Protocol Buffers reference.
In some languages, built-in datetime utilities do not support nanosecond precision (9 digits).

done

boolean

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

object

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.

error

Status

The error result of the operation in case of failure or cancellation.

Includes only one of the fields error, 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.

response

object

The normal response of the operation in case of success.
If the original method returns no data on success, such as Delete,
the response is google.protobuf.Empty.
If the original method is the standard Create/Update,
the response should be the target resource of the operation.
Any method that returns a long-running operation should document the response type, if any.

Includes only one of the fields error, 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.

Field

Description

code

integer (int32)

Error code. An enum value of google.rpc.Code.

message

string

An error message.

details[]

object

A list of messages that carry the error details.