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

Written by

Updated at September 21, 2026

HTTP request
Path parameters
Body parameters
HttpBackend
Target
SessionAffinity
ConnectionSessionAffinity
HeaderSessionAffinity
CookieSessionAffinity
TlsListener
HttpListener
SolidWafSettings
RateLimit
Response
Status

Creates a domain in the specified load balancer.

HTTP request

POST https://smartwebsecurity.api.cloud.yandex.net/smartwebsecurity/v1/loadBalancers/{loadBalancerId}/domains

Path parameters

Field

Description

loadBalancerId

string

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

Body parameters

{
  "name": "string",
  "serverName": "string",
  "description": "string",
  "securityProfileId": "string",
  "httpBackend": {
    "targets": [
      {
        "ipAddress": "string",
        "description": "string",
        "port": "string"
      }
    ],
    "useHttp2": "boolean",
    "useTls": "boolean",
    "sni": "string",
    "trustedCaBytes": "string",
    "timeout": "string",
    "idleTimeout": "string",
    "sessionAffinity": {
      // Includes only one of the fields `connection`, `header`, `cookie`
      "connection": {
        "sourceIp": "boolean"
      },
      "header": {
        "headerName": "string"
      },
      "cookie": {
        "name": "string",
        "ttl": "string",
        "path": "string"
      }
      // end of the list of possible fields
    }
  },
  "tlsListener": {
    "enabled": "boolean",
    "certificateId": "string",
    "port": "string",
    "enableHttp1": "boolean"
  },
  "httpListener": {
    "enabled": "boolean",
    "redirectToHttps": "boolean",
    "port": "string"
  },
  "solidWafSettings": {
    "solidWafProfileId": "string",
    "sessionAffinity": {
      // Includes only one of the fields `connection`, `header`, `cookie`
      "connection": {
        "sourceIp": "boolean"
      },
      "header": {
        "headerName": "string"
      },
      "cookie": {
        "name": "string",
        "ttl": "string",
        "path": "string"
      }
      // end of the list of possible fields
    },
    "webAppId": "string"
  },
  "rateLimit": {
    "allRequestsPerSecond": "string",
    "requestsPerIpPerSecond": "string"
  }
}

Field	Description
name	string Unique name of domain within the balancer. Will be used for monitoring naming and error messages. If empty, will be generated automaticly from server_name. Value must match the regular expression `\|[a-z][-a-z0-9]{1,56}[a-z0-9]`.
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.

HttpBackend

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.

Target

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.

SessionAffinity

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`.

ConnectionSessionAffinity

Field

Description

sourceIp

boolean

IP address.

HeaderSessionAffinity

Field

Description

headerName

string

Header name.

The string length in characters must be 1-256.

CookieSessionAffinity

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.

TlsListener

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.

HttpListener

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.

SolidWafSettings

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.

RateLimit

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.

Response

HTTP Code: 200 - OK

{
  "id": "string",
  "description": "string",
  "createdAt": "string",
  "createdBy": "string",
  "modifiedAt": "string",
  "done": "boolean",
  "metadata": "object",
  // Includes only one of the fields `error`, `response`
  "error": {
    "code": "integer",
    "message": "string",
    "details": [
      "object"
    ]
  },
  "response": "object"
  // end of the list of possible fields
}

An Operation resource. For more information, see Operation.

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.

Status

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

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.

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

HTTP requestHTTP request

Path parametersPath parameters

Body parametersBody parameters

HttpBackendHttpBackend

TargetTarget

SessionAffinitySessionAffinity

ConnectionSessionAffinityConnectionSessionAffinity

HeaderSessionAffinityHeaderSessionAffinity

CookieSessionAffinityCookieSessionAffinity

TlsListenerTlsListener

HttpListenerHttpListener

SolidWafSettingsSolidWafSettings

RateLimitRateLimit

ResponseResponse

StatusStatus

Was the article helpful?

HTTP request

Path parameters

Body parameters

HttpBackend

Target

SessionAffinity

ConnectionSessionAffinity

HeaderSessionAffinity

CookieSessionAffinity

TlsListener

HttpListener

SolidWafSettings

RateLimit

Response

Status