--- title: "Submit an external event" method: POST path: "/events" tags: ["events"] --- # Submit an external event `POST /events` Submit an external event to add to the event log. ## Request body - EventPost - `subject` string, required — The object that is affected by the event (e.g. A cluster scale out event for cluster w234fs will have a subject of /v2/cluster/w234fs). - `message` string, required — Text that describes the occurrence of an event. - `severity` 'info' | 'severe' | 'warning', required — The severity of the event. There are three levels: info is informational and no action is needed, warning may indicate that an error will occur if action is not taken, severe is critical and requires immediate attention (e.g. the application is down). - `type` string, required — The type of event. For external events, the type may not begin with 'system-'. - `details` object, nullable — Optional additional structured information about this event. - `origin` string — The third-party entity that generated the event. - `originated` string — An iso8601 formatted timestamp ## Response `200` The call was successful. - Event - `created` string, required — An iso8601 formatted timestamp - `details` union — Additional structured information about the event. The specific structure depends on the type of the event. For custom user events this can be any JSON object. - EventActionDetails — Event log details of type action - `name` string, required — Name of the action that was executed on the system - `snapshot` union - object - `name` string — The name of the application. - `aliases` string[] — Ordered array of application domain names. The first array entry will be used as the primary application domain name. - `bot_management` BotManagement - `user_agent` boolean, required — When set to true, bot identification takes place using user-agent of the request. - `cdn_aliases` string[] — Array of application domain names published to CDN. - `components` Component[] — List of resource layers that are attached to this application. Examples of such resources include EC2 or RDS instances available in an AWS cloud provider. - `layer_name` string — Name of the resource layer being referenced here. - `element` string — The endpoint for a resource accessible via services available for this account. - `cdn_configuration` CdnConfiguration - `controls` CdnControl[], required — Array of cdn controls to be configured with the cdn distribution. - … - `cdn_ready` boolean — True when a delivery = cdn has been configured and is ready. - `cdn_service` string — A href to the cdn service configured for the application. - `default_hostname` string — Alias for an application - `dns_service` string, nullable — A href to the dns service configured for the application. - `servers_hostname` union - unknown - string — A fully qualified domain name (FQD) whose addresses are used to set the backend servers to which traffic should be sent - `delivery` 'cdn' | 'rewrite-to-cdn' | 'without-cdn' — The mode of delivery for an application. One of 'cdn', 'without-cdn', or 'rewrite-to-cdn'. The 'rewrite-to-cdn' mode is not recommended for new applications - `enable_cdn` boolean — Enable CDN for the application. This is not used if the 'delivery' attribute is set - `enable_http2` boolean — Enable HTTP2 for the application. - `enable_rum` boolean — Enable RUM for the application. - `enable_tls` boolean — Enable TLS for the application. The tls_configuration is required if true. - `tls_configuration` TlsConfiguration - `private_key` union — A reference to a secret containing a private key - … - `private_keys` union[] — A reference to an array of secrets containing private keys - … - `certificate_chain` string — The signed certificate followed by any intermediate certificate chain. - `enable_auto_tls` boolean — When enabled Auto TLS will configure your application to automatically obtain and renew certificates from Let's Encrypt. - `enable_force_tls` boolean — Force HTTP traffic to be routed over HTTPS for the application. - `enable_tls_offloading` boolean — When enabled the ADC tier will act as a TLS termination proxy, decrypting incoming HTTPS traffic and routing the unencrypted traffic to the application tier over HTTP. Response from the application tier are encrypted at the ADC tier and routed over HTTPS back to the client. - `enable_server_validation` boolean — Enable validation of the TLS certificate chain against the application servers. - `tolerate_invalid_chain` boolean — Tolerate certificate chain errors in certificates presented by the application servers. - `versions` TlsVersion[] — The versions of TLS that will be accepted for this application - `covered_aliases` CoveredAlias[] — Covered aliases by tls configuration for this application - … - `metrics` MetricConfiguration[] — Array of metric configurations attached for the application - `name` string — Name of the metric - `frequency` integer — Frequency at which metrics are populated - `prototype` string, required — A reference to the metric prototype - `monitoring` 'none' | 'passive' | 'active' — The monitoring mode. When active, the application will be monitored regularly from a separate location, in addition to passive monitoring. When passive, the error rate for the application is monitored and used to generate alerts, but if there is no regular activity to the application, then no outage will be detected. - `waf_rules` WafFileReference[] — The waf rules for the application. - `file` ResourceReference, required - … - `name` string, required — The name of the waf rule. - `created` string, date-time — The timestamp when a waf rule was uploaded. - `active` integer, required — Indicates if the waf rule is active or not. 1 represents active and 0 is inactive. - `whitelist` AddressSetEntry[] — A list of addresses to always be allowed access. - `created` string — An iso8601 formatted timestamp - `created_by` string — Reference to the user that created this id - `description` string — Description of the address - `address` string, required — A ip address or range. - `expiry` string — An iso8601 formatted timestamp - `whitelist_href` string — The endpoint for an address set resource - `blacklist` AddressSetEntry[] — A list of addresses to be restricted access. - `created` string — An iso8601 formatted timestamp - `created_by` string — Reference to the user that created this id - `description` string — Description of the address - `address` string, required — A ip address or range. - `expiry` string — An iso8601 formatted timestamp - `blacklist_href` string — The endpoint for an address set resource - `blacklist_user_agents` string, nullable — A regular expression of user agents to be restricted access. - `concurrent_limit` integer — Maximum number of concurrently active requests that can be run in a load balancer before requests are put in the suspend queue. This attribute may only be set by system administrators - `maximum_queue_time` integer — Maximum amount of time a request can spend in the suspend queue of a load balancer before it is failed with a timeout. This attribute may only be set by system administrators - `merge_slashes` boolean — Controls whether the server merges consecutive slashes in URLs. By default, consecutive slashes are merged into a single slash. - `suspend_limit` integer — Maximum number of requests that can be put in the suspend queue of a load balancer before the oldest requests are failed. This attribute may only be set by system administrators - `probes` string[] - `protection` 'normal' | 'maximum' — The protection mode. - `protection_captcha_retry_limit` integer — Number of incorrect attempts a user is allowed before the user may be blacklisted. - `protection_blacklist_timeout` integer — Number of seconds to enforce blacklist on the suspicious user. - `protection_microsite_file` string — Endpoint for the file id associated with the captcha microsite. - `cluster` string, nullable — The endpoint for the cluster resource. - `servers` union - unknown - ApplicationServer[] — Application static servers. - … - `page_controls` PageControlConfiguration[] — An array of specific mode page controls processed in sequence to modify the behavior of request processing - `name` string, required — Short name describing the page control. - `description` string — Optional additional description of the page control. - `mode` 'maintenance' | 'request' | 'response' — Set as 'maintenance' for maintenance mode page control. - `enabled` boolean — Enables or disables the page control. - `conditions` PageControlConditions — The conditions that cause a page control to trigger - … - `actions` PageControlAction[], required — Actions that are applied when the page control is triggered. - … - `request_timeout` integer — Time for which Webscale proxy will wait for a backend server to respond. If proxy does not receive response in a specified time from the backend server, a maintenance page with status 502 Bad Gateway will be returned - `shields` union[] — A list of href's referencing firewalls that can be enabled/disabled for the application. - union - … - `shields_include_whitelist` boolean — Add whitelist addresses to shields. By default whitelist addresses are not added to the shields. Google cloud supports only IPv4 addresses in their firewall rules. Any IPv6 addresses in the whitelist will not be added to the firewall rules for Google. AWS supports both IPv4 and IPv6 addresses in the security groups - `site_cache` union - unknown - SiteCache — A configuration for Dynamic Site Cache - … - `trusted_proxies` union - unknown - AddressSetHref[] — Trust only the referenced peers. The client address from the X-Forwarded-For header is accepted provided that the peer address is in one of the referenced sets, but otherwise ignored. If the array is empty, then no proxies are trusted and the X-Forwarded-For header is ignored. - `data_planes` string[] — Configured data planes - `trusted_proxies_only` boolean — Allows external traffic only from addresses from the configured trusted proxies, the control addresses, and pingdom. - `trusted_proxies_header` string — The name of the header from a trusted proxy that is used to obtain the request address. When not set, X-Forwarded-For is used. - `labels` Label[] — Array of labels that will be attached to the application. - `translate_path` 'preserve' | 'unescape' — Configuration to specify the handling of URL paths through the Webscale proxy. The default behavior is to leave the path value untouched (preserve). A value of 'unescape' would remove all escaped characters in the path and replace them with their equivalent unicode character. - `pagespeed_disallow` string[] — A set of URL patterns to exclude from pagespeed optimization - `pagespeed_exclude_agents` string — User agents that match this regular expression are excluded from pagespeed - `pagespeed_map_proxy_domains` string[] — A set of domains that are integrated into the pages for this site - `microsite` string — Endpoint resource reference to a file. - `web_controls` WebControlConfiguration[] — An array of specific mode web controls processed in sequence to modify the behavior of request processing - `name` string, required — Short name describing the web control. - `description` string — Optional additional description of the web control. - `mode` 'maintenance' | 'request' | 'response' — Set as 'maintenance' for maintenance mode web control. - `enabled` boolean — Enables or disables the web control. - `conditions` WebControlCondition[] — An array of conditions. When empty, all requests match - … - `actions` PageControlAction[], required — Actions that are applied when the web control is triggered. - … - `stratus_id` union - unknown - string — Identification for stratus applications - `log_retention` ApplicationLogRetention[] — An array of application log retention configuration objects - `type` 'default' | 'cdn' | 'custom' | 'csp-reports' | 'pageviews' | 'proxy-logs', required — Type of log retention - `online_days` integer — Number of online days - `archive_days` integer — Number of archive days - `online_space_allowance` integer — Allowance for online space - `archive_space_allowance` integer — Allowance for archive space - object - `name` string - `minimum_size` integer — An integer of value 0 or more. - `maximum_size` integer — An integer of value 0 or more. - `manual_size` union — The explicit size that a cluster will scale to. Overrides automatic size. - unknown - integer — An integer of value 0 or more. - `instance_type` 'micro' | 'small' | 'medium' | 'large' | 'xlarge' — Specifies the type (size) of instances to be created. - `scale_in_conditions` ScalingCondition[] — When any of these conditions become true for a server, then the cluster automatic size will be reduced by one. - `series_name` 'cpu_percent' | 'iowait_percent' | 'kilobytes_per_second' | 'loadavg_norm' | 'memory_used_percent' | 'requests_per_second', required — Name identifying the scaling condition type. - `operator` 'has_been_greater_than' | 'will_be_greater_than' | 'has_been_less_than' | 'will_be_less_than', required — Operator to determine scaling condition. - `value` number, required — Threshold value to trigger scaling in or out of servers. - `duration` integer, required — An integer of value 0 or more. - `display_unit` 'seconds' | 'minutes' | 'hours', required — Unit to use for displaying the time duration specified. - `scale_out_conditions` ScalingCondition[] — When any of these conditions become true for a server, then the cluster automatic size will be increased by one. - `series_name` 'cpu_percent' | 'iowait_percent' | 'kilobytes_per_second' | 'loadavg_norm' | 'memory_used_percent' | 'requests_per_second', required — Name identifying the scaling condition type. - `operator` 'has_been_greater_than' | 'will_be_greater_than' | 'has_been_less_than' | 'will_be_less_than', required — Operator to determine scaling condition. - `value` number, required — Threshold value to trigger scaling in or out of servers. - `duration` integer, required — An integer of value 0 or more. - `display_unit` 'seconds' | 'minutes' | 'hours', required — Unit to use for displaying the time duration specified. - `server_blueprints` Blueprint[] — Specifies how servers in this cluster are to be built. - `files` MetadataFileEntry[] — A set of files to be made available on servers created with this blueprint. - … - `identity` IdentityConfiguration — Configuration of the identity assigned to cluster servers. - … - `image` string — Resource href that includes the Webscale provider identifier. - `instance_template` string — The endpoint resource identifier for the instance template. - `instance_type` string — Resource href that includes the Webscale provider identifier. - `metadata` MetadataEntry[] — A set of key/value pairs that will be provided to servers created with this blueprint. Server blueprint metadata overrides the cluster metadata on a key-by-key basis. - … - `networks` ProviderResourceHref[] — List of network or subnet endpoint resource references to associate the server with. Network availability may be limited to specific zones depending on the cloud provider. - `network_tags` string[] — List of network tags to associate with the server. Only applicable for Google provider. - `placement` union - … - `provider` Provider - … - `security_groups` SecurityGroupHref[] — List of security group endpoint resource references to associate with the server. Only applicable for AWS provider. - `storage_account` string — Resource href that includes the Webscale provider identifier. - `zone` string — Resource href that includes the Webscale provider identifier. - `bootstrap` BootstrapConfiguration - `file` string, required — Endpoint resource reference to a file. - `command` string, required — Cloud Init command to run once the server is commissioned. - `minimum_increment` integer — An integer of value 1 or more. - `server_failure_timeout` integer — An integer of value 0 or more. - `servers_update_webhook` string, uri — An HTTP URL address. - `verify_timeout` integer — The time to wait for a new server to verify. If a server does not respond to a GET / with a non-5xx status code after this many seconds, then it fails verification and will be replaced or destroyed - `failed_server_disposition` 'destroy' | 'detach' — If set to detach, failed servers won't be deleted from cloud provider after deletion. - `allocate_public_address` boolean — When set to true, server will have a public address associated with it. If set to false, the server will not have public address. Before making this change, please make sure that the proxy and servers with private addresses are in the same network. NOTE: As of now, this functionality is only supported for Centurylink cloud. - `measurement_type` 'none' | 'lg-status' | 'self-reporting' — When self-reporting, server will post its measurements to /v2/servers/metrics periodically. When lg-status, server needs to be installed with lg_mod_status and Webscale will pull the measurements from the server periodically. When none, Webscale will not monitor the cluster - `checks` Check[] — List of checks that needs to be performed to verify cluster server. - `url` string, uri, required — URL to perform server verification on. - `allowed_status_code` string, regex — Regular expression to check the status code for responses to verification requests, when it is not satisfied the check will be deemed as a failure. Defaults to '/^[23]/' - `body` string — Request body which needs to be sent with verification request. Defaults to empty string. - `headers` Header[] — Array of headers that needs to be included in the verification request. Defaults to no headers. - … - `permitted_redirect_hosts` Alias[] — A list of host names to follow when redirect responses are received during verification. Defaults to empty list. - `prohibit_content` string, regex — A regular expression applied on the response body that if matched fails the check. Defaults to no regular expression. - `request_method` string — HTTP request method to use when sending verification requests. Defaults to 'GET' - `require_content` string, regex — A regular expression applied on the response body that must match for the check to succeed. Defaults to no regular expression. - `timeout` integer — Number of seconds to wait for the response from server. Defaults to 30 seconds. - `verify_certificates` boolean — Flag when set to true directs the check to verify the validity of the offered certificates. Defaults to true. - `metadata` MetadataEntry[] — A set of key/value pairs that will be provided to servers created in this cluster. Server blueprint metadata overrides the cluster metadata on a key-by-key basis. - `key` string — A key name. - `value` string — A value associated with the given key. - `files` MetadataFileEntry[] — A set of files to be made available on servers created with this blueprint. Server blueprint files overrides cluster files on a key-by-key basis. - `file` string — A reference to a Webscale file. - `path` string — The absolute path where the file is made available on a server made with this blueprint. - object — A generic configuration model object that is to be used when an object specific configuration model schema is not found. - EventActionDetails — Event log details of type action - `name` string, required — Name of the action that was executed on the system - `snapshot` union - object - `name` string — The name of the application. - `aliases` string[] — Ordered array of application domain names. The first array entry will be used as the primary application domain name. - `bot_management` BotManagement - `user_agent` boolean, required — When set to true, bot identification takes place using user-agent of the request. - `cdn_aliases` string[] — Array of application domain names published to CDN. - `components` Component[] — List of resource layers that are attached to this application. Examples of such resources include EC2 or RDS instances available in an AWS cloud provider. - `layer_name` string — Name of the resource layer being referenced here. - `element` string — The endpoint for a resource accessible via services available for this account. - `cdn_configuration` CdnConfiguration - `controls` CdnControl[], required — Array of cdn controls to be configured with the cdn distribution. - … - `cdn_ready` boolean — True when a delivery = cdn has been configured and is ready. - `cdn_service` string — A href to the cdn service configured for the application. - `default_hostname` string — Alias for an application - `dns_service` string, nullable — A href to the dns service configured for the application. - `servers_hostname` union - unknown - string — A fully qualified domain name (FQD) whose addresses are used to set the backend servers to which traffic should be sent - `delivery` 'cdn' | 'rewrite-to-cdn' | 'without-cdn' — The mode of delivery for an application. One of 'cdn', 'without-cdn', or 'rewrite-to-cdn'. The 'rewrite-to-cdn' mode is not recommended for new applications - `enable_cdn` boolean — Enable CDN for the application. This is not used if the 'delivery' attribute is set - `enable_http2` boolean — Enable HTTP2 for the application. - `enable_rum` boolean — Enable RUM for the application. - `enable_tls` boolean — Enable TLS for the application. The tls_configuration is required if true. - `tls_configuration` TlsConfiguration - `private_key` union — A reference to a secret containing a private key - … - `private_keys` union[] — A reference to an array of secrets containing private keys - … - `certificate_chain` string — The signed certificate followed by any intermediate certificate chain. - `enable_auto_tls` boolean — When enabled Auto TLS will configure your application to automatically obtain and renew certificates from Let's Encrypt. - `enable_force_tls` boolean — Force HTTP traffic to be routed over HTTPS for the application. - `enable_tls_offloading` boolean — When enabled the ADC tier will act as a TLS termination proxy, decrypting incoming HTTPS traffic and routing the unencrypted traffic to the application tier over HTTP. Response from the application tier are encrypted at the ADC tier and routed over HTTPS back to the client. - `enable_server_validation` boolean — Enable validation of the TLS certificate chain against the application servers. - `tolerate_invalid_chain` boolean — Tolerate certificate chain errors in certificates presented by the application servers. - `versions` TlsVersion[] — The versions of TLS that will be accepted for this application - `covered_aliases` CoveredAlias[] — Covered aliases by tls configuration for this application - … - `metrics` MetricConfiguration[] — Array of metric configurations attached for the application - `name` string — Name of the metric - `frequency` integer — Frequency at which metrics are populated - `prototype` string, required — A reference to the metric prototype - `monitoring` 'none' | 'passive' | 'active' — The monitoring mode. When active, the application will be monitored regularly from a separate location, in addition to passive monitoring. When passive, the error rate for the application is monitored and used to generate alerts, but if there is no regular activity to the application, then no outage will be detected. - `waf_rules` WafFileReference[] — The waf rules for the application. - `file` ResourceReference, required - … - `name` string, required — The name of the waf rule. - `created` string, date-time — The timestamp when a waf rule was uploaded. - `active` integer, required — Indicates if the waf rule is active or not. 1 represents active and 0 is inactive. - `whitelist` AddressSetEntry[] — A list of addresses to always be allowed access. - `created` string — An iso8601 formatted timestamp - `created_by` string — Reference to the user that created this id - `description` string — Description of the address - `address` string, required — A ip address or range. - `expiry` string — An iso8601 formatted timestamp - `whitelist_href` string — The endpoint for an address set resource - `blacklist` AddressSetEntry[] — A list of addresses to be restricted access. - `created` string — An iso8601 formatted timestamp - `created_by` string — Reference to the user that created this id - `description` string — Description of the address - `address` string, required — A ip address or range. - `expiry` string — An iso8601 formatted timestamp - `blacklist_href` string — The endpoint for an address set resource - `blacklist_user_agents` string, nullable — A regular expression of user agents to be restricted access. - `concurrent_limit` integer — Maximum number of concurrently active requests that can be run in a load balancer before requests are put in the suspend queue. This attribute may only be set by system administrators - `maximum_queue_time` integer — Maximum amount of time a request can spend in the suspend queue of a load balancer before it is failed with a timeout. This attribute may only be set by system administrators - `merge_slashes` boolean — Controls whether the server merges consecutive slashes in URLs. By default, consecutive slashes are merged into a single slash. - `suspend_limit` integer — Maximum number of requests that can be put in the suspend queue of a load balancer before the oldest requests are failed. This attribute may only be set by system administrators - `probes` string[] - `protection` 'normal' | 'maximum' — The protection mode. - `protection_captcha_retry_limit` integer — Number of incorrect attempts a user is allowed before the user may be blacklisted. - `protection_blacklist_timeout` integer — Number of seconds to enforce blacklist on the suspicious user. - `protection_microsite_file` string — Endpoint for the file id associated with the captcha microsite. - `cluster` string, nullable — The endpoint for the cluster resource. - `servers` union - unknown - ApplicationServer[] — Application static servers. - … - `page_controls` PageControlConfiguration[] — An array of specific mode page controls processed in sequence to modify the behavior of request processing - `name` string, required — Short name describing the page control. - `description` string — Optional additional description of the page control. - `mode` 'maintenance' | 'request' | 'response' — Set as 'maintenance' for maintenance mode page control. - `enabled` boolean — Enables or disables the page control. - `conditions` PageControlConditions — The conditions that cause a page control to trigger - … - `actions` PageControlAction[], required — Actions that are applied when the page control is triggered. - … - `request_timeout` integer — Time for which Webscale proxy will wait for a backend server to respond. If proxy does not receive response in a specified time from the backend server, a maintenance page with status 502 Bad Gateway will be returned - `shields` union[] — A list of href's referencing firewalls that can be enabled/disabled for the application. - union - … - `shields_include_whitelist` boolean — Add whitelist addresses to shields. By default whitelist addresses are not added to the shields. Google cloud supports only IPv4 addresses in their firewall rules. Any IPv6 addresses in the whitelist will not be added to the firewall rules for Google. AWS supports both IPv4 and IPv6 addresses in the security groups - `site_cache` union - unknown - SiteCache — A configuration for Dynamic Site Cache - … - `trusted_proxies` union - unknown - AddressSetHref[] — Trust only the referenced peers. The client address from the X-Forwarded-For header is accepted provided that the peer address is in one of the referenced sets, but otherwise ignored. If the array is empty, then no proxies are trusted and the X-Forwarded-For header is ignored. - `data_planes` string[] — Configured data planes - `trusted_proxies_only` boolean — Allows external traffic only from addresses from the configured trusted proxies, the control addresses, and pingdom. - `trusted_proxies_header` string — The name of the header from a trusted proxy that is used to obtain the request address. When not set, X-Forwarded-For is used. - `labels` Label[] — Array of labels that will be attached to the application. - `translate_path` 'preserve' | 'unescape' — Configuration to specify the handling of URL paths through the Webscale proxy. The default behavior is to leave the path value untouched (preserve). A value of 'unescape' would remove all escaped characters in the path and replace them with their equivalent unicode character. - `pagespeed_disallow` string[] — A set of URL patterns to exclude from pagespeed optimization - `pagespeed_exclude_agents` string — User agents that match this regular expression are excluded from pagespeed - `pagespeed_map_proxy_domains` string[] — A set of domains that are integrated into the pages for this site - `microsite` string — Endpoint resource reference to a file. - `web_controls` WebControlConfiguration[] — An array of specific mode web controls processed in sequence to modify the behavior of request processing - `name` string, required — Short name describing the web control. - `description` string — Optional additional description of the web control. - `mode` 'maintenance' | 'request' | 'response' — Set as 'maintenance' for maintenance mode web control. - `enabled` boolean — Enables or disables the web control. - `conditions` WebControlCondition[] — An array of conditions. When empty, all requests match - … - `actions` PageControlAction[], required — Actions that are applied when the web control is triggered. - … - `stratus_id` union - unknown - string — Identification for stratus applications - `log_retention` ApplicationLogRetention[] — An array of application log retention configuration objects - `type` 'default' | 'cdn' | 'custom' | 'csp-reports' | 'pageviews' | 'proxy-logs', required — Type of log retention - `online_days` integer — Number of online days - `archive_days` integer — Number of archive days - `online_space_allowance` integer — Allowance for online space - `archive_space_allowance` integer — Allowance for archive space - object - `name` string - `minimum_size` integer — An integer of value 0 or more. - `maximum_size` integer — An integer of value 0 or more. - `manual_size` union — The explicit size that a cluster will scale to. Overrides automatic size. - unknown - integer — An integer of value 0 or more. - `instance_type` 'micro' | 'small' | 'medium' | 'large' | 'xlarge' — Specifies the type (size) of instances to be created. - `scale_in_conditions` ScalingCondition[] — When any of these conditions become true for a server, then the cluster automatic size will be reduced by one. - `series_name` 'cpu_percent' | 'iowait_percent' | 'kilobytes_per_second' | 'loadavg_norm' | 'memory_used_percent' | 'requests_per_second', required — Name identifying the scaling condition type. - `operator` 'has_been_greater_than' | 'will_be_greater_than' | 'has_been_less_than' | 'will_be_less_than', required — Operator to determine scaling condition. - `value` number, required — Threshold value to trigger scaling in or out of servers. - `duration` integer, required — An integer of value 0 or more. - `display_unit` 'seconds' | 'minutes' | 'hours', required — Unit to use for displaying the time duration specified. - `scale_out_conditions` ScalingCondition[] — When any of these conditions become true for a server, then the cluster automatic size will be increased by one. - `series_name` 'cpu_percent' | 'iowait_percent' | 'kilobytes_per_second' | 'loadavg_norm' | 'memory_used_percent' | 'requests_per_second', required — Name identifying the scaling condition type. - `operator` 'has_been_greater_than' | 'will_be_greater_than' | 'has_been_less_than' | 'will_be_less_than', required — Operator to determine scaling condition. - `value` number, required — Threshold value to trigger scaling in or out of servers. - `duration` integer, required — An integer of value 0 or more. - `display_unit` 'seconds' | 'minutes' | 'hours', required — Unit to use for displaying the time duration specified. - `server_blueprints` Blueprint[] — Specifies how servers in this cluster are to be built. - `files` MetadataFileEntry[] — A set of files to be made available on servers created with this blueprint. - … - `identity` IdentityConfiguration — Configuration of the identity assigned to cluster servers. - … - `image` string — Resource href that includes the Webscale provider identifier. - `instance_template` string — The endpoint resource identifier for the instance template. - `instance_type` string — Resource href that includes the Webscale provider identifier. - `metadata` MetadataEntry[] — A set of key/value pairs that will be provided to servers created with this blueprint. Server blueprint metadata overrides the cluster metadata on a key-by-key basis. - … - `networks` ProviderResourceHref[] — List of network or subnet endpoint resource references to associate the server with. Network availability may be limited to specific zones depending on the cloud provider. - `network_tags` string[] — List of network tags to associate with the server. Only applicable for Google provider. - `placement` union - … - `provider` Provider - … - `security_groups` SecurityGroupHref[] — List of security group endpoint resource references to associate with the server. Only applicable for AWS provider. - `storage_account` string — Resource href that includes the Webscale provider identifier. - `zone` string — Resource href that includes the Webscale provider identifier. - `bootstrap` BootstrapConfiguration - `file` string, required — Endpoint resource reference to a file. - `command` string, required — Cloud Init command to run once the server is commissioned. - `minimum_increment` integer — An integer of value 1 or more. - `server_failure_timeout` integer — An integer of value 0 or more. - `servers_update_webhook` string, uri — An HTTP URL address. - `verify_timeout` integer — The time to wait for a new server to verify. If a server does not respond to a GET / with a non-5xx status code after this many seconds, then it fails verification and will be replaced or destroyed - `failed_server_disposition` 'destroy' | 'detach' — If set to detach, failed servers won't be deleted from cloud provider after deletion. - `allocate_public_address` boolean — When set to true, server will have a public address associated with it. If set to false, the server will not have public address. Before making this change, please make sure that the proxy and servers with private addresses are in the same network. NOTE: As of now, this functionality is only supported for Centurylink cloud. - `measurement_type` 'none' | 'lg-status' | 'self-reporting' — When self-reporting, server will post its measurements to /v2/servers/metrics periodically. When lg-status, server needs to be installed with lg_mod_status and Webscale will pull the measurements from the server periodically. When none, Webscale will not monitor the cluster - `checks` Check[] — List of checks that needs to be performed to verify cluster server. - `url` string, uri, required — URL to perform server verification on. - `allowed_status_code` string, regex — Regular expression to check the status code for responses to verification requests, when it is not satisfied the check will be deemed as a failure. Defaults to '/^[23]/' - `body` string — Request body which needs to be sent with verification request. Defaults to empty string. - `headers` Header[] — Array of headers that needs to be included in the verification request. Defaults to no headers. - … - `permitted_redirect_hosts` Alias[] — A list of host names to follow when redirect responses are received during verification. Defaults to empty list. - `prohibit_content` string, regex — A regular expression applied on the response body that if matched fails the check. Defaults to no regular expression. - `request_method` string — HTTP request method to use when sending verification requests. Defaults to 'GET' - `require_content` string, regex — A regular expression applied on the response body that must match for the check to succeed. Defaults to no regular expression. - `timeout` integer — Number of seconds to wait for the response from server. Defaults to 30 seconds. - `verify_certificates` boolean — Flag when set to true directs the check to verify the validity of the offered certificates. Defaults to true. - `metadata` MetadataEntry[] — A set of key/value pairs that will be provided to servers created in this cluster. Server blueprint metadata overrides the cluster metadata on a key-by-key basis. - `key` string — A key name. - `value` string — A value associated with the given key. - `files` MetadataFileEntry[] — A set of files to be made available on servers created with this blueprint. Server blueprint files overrides cluster files on a key-by-key basis. - `file` string — A reference to a Webscale file. - `path` string — The absolute path where the file is made available on a server made with this blueprint. - object — A generic configuration model object that is to be used when an object specific configuration model schema is not found. - EventCreateDetails — Event log details of type create - `snapshot` union, required - object - `name` string — The name of the application. - `aliases` string[] — Ordered array of application domain names. The first array entry will be used as the primary application domain name. - `bot_management` BotManagement - `user_agent` boolean, required — When set to true, bot identification takes place using user-agent of the request. - `cdn_aliases` string[] — Array of application domain names published to CDN. - `components` Component[] — List of resource layers that are attached to this application. Examples of such resources include EC2 or RDS instances available in an AWS cloud provider. - `layer_name` string — Name of the resource layer being referenced here. - `element` string — The endpoint for a resource accessible via services available for this account. - `cdn_configuration` CdnConfiguration - `controls` CdnControl[], required — Array of cdn controls to be configured with the cdn distribution. - … - `cdn_ready` boolean — True when a delivery = cdn has been configured and is ready. - `cdn_service` string — A href to the cdn service configured for the application. - `default_hostname` string — Alias for an application - `dns_service` string, nullable — A href to the dns service configured for the application. - `servers_hostname` union - unknown - string — A fully qualified domain name (FQD) whose addresses are used to set the backend servers to which traffic should be sent - `delivery` 'cdn' | 'rewrite-to-cdn' | 'without-cdn' — The mode of delivery for an application. One of 'cdn', 'without-cdn', or 'rewrite-to-cdn'. The 'rewrite-to-cdn' mode is not recommended for new applications - `enable_cdn` boolean — Enable CDN for the application. This is not used if the 'delivery' attribute is set - `enable_http2` boolean — Enable HTTP2 for the application. - `enable_rum` boolean — Enable RUM for the application. - `enable_tls` boolean — Enable TLS for the application. The tls_configuration is required if true. - `tls_configuration` TlsConfiguration - `private_key` union — A reference to a secret containing a private key - … - `private_keys` union[] — A reference to an array of secrets containing private keys - … - `certificate_chain` string — The signed certificate followed by any intermediate certificate chain. - `enable_auto_tls` boolean — When enabled Auto TLS will configure your application to automatically obtain and renew certificates from Let's Encrypt. - `enable_force_tls` boolean — Force HTTP traffic to be routed over HTTPS for the application. - `enable_tls_offloading` boolean — When enabled the ADC tier will act as a TLS termination proxy, decrypting incoming HTTPS traffic and routing the unencrypted traffic to the application tier over HTTP. Response from the application tier are encrypted at the ADC tier and routed over HTTPS back to the client. - `enable_server_validation` boolean — Enable validation of the TLS certificate chain against the application servers. - `tolerate_invalid_chain` boolean — Tolerate certificate chain errors in certificates presented by the application servers. - `versions` TlsVersion[] — The versions of TLS that will be accepted for this application - `covered_aliases` CoveredAlias[] — Covered aliases by tls configuration for this application - … - `metrics` MetricConfiguration[] — Array of metric configurations attached for the application - `name` string — Name of the metric - `frequency` integer — Frequency at which metrics are populated - `prototype` string, required — A reference to the metric prototype - `monitoring` 'none' | 'passive' | 'active' — The monitoring mode. When active, the application will be monitored regularly from a separate location, in addition to passive monitoring. When passive, the error rate for the application is monitored and used to generate alerts, but if there is no regular activity to the application, then no outage will be detected. - `waf_rules` WafFileReference[] — The waf rules for the application. - `file` ResourceReference, required - … - `name` string, required — The name of the waf rule. - `created` string, date-time — The timestamp when a waf rule was uploaded. - `active` integer, required — Indicates if the waf rule is active or not. 1 represents active and 0 is inactive. - `whitelist` AddressSetEntry[] — A list of addresses to always be allowed access. - `created` string — An iso8601 formatted timestamp - `created_by` string — Reference to the user that created this id - `description` string — Description of the address - `address` string, required — A ip address or range. - `expiry` string — An iso8601 formatted timestamp - `whitelist_href` string — The endpoint for an address set resource - `blacklist` AddressSetEntry[] — A list of addresses to be restricted access. - `created` string — An iso8601 formatted timestamp - `created_by` string — Reference to the user that created this id - `description` string — Description of the address - `address` string, required — A ip address or range. - `expiry` string — An iso8601 formatted timestamp - `blacklist_href` string — The endpoint for an address set resource - `blacklist_user_agents` string, nullable — A regular expression of user agents to be restricted access. - `concurrent_limit` integer — Maximum number of concurrently active requests that can be run in a load balancer before requests are put in the suspend queue. This attribute may only be set by system administrators - `maximum_queue_time` integer — Maximum amount of time a request can spend in the suspend queue of a load balancer before it is failed with a timeout. This attribute may only be set by system administrators - `merge_slashes` boolean — Controls whether the server merges consecutive slashes in URLs. By default, consecutive slashes are merged into a single slash. - `suspend_limit` integer — Maximum number of requests that can be put in the suspend queue of a load balancer before the oldest requests are failed. This attribute may only be set by system administrators - `probes` string[] - `protection` 'normal' | 'maximum' — The protection mode. - `protection_captcha_retry_limit` integer — Number of incorrect attempts a user is allowed before the user may be blacklisted. - `protection_blacklist_timeout` integer — Number of seconds to enforce blacklist on the suspicious user. - `protection_microsite_file` string — Endpoint for the file id associated with the captcha microsite. - `cluster` string, nullable — The endpoint for the cluster resource. - `servers` union - unknown - ApplicationServer[] — Application static servers. - … - `page_controls` PageControlConfiguration[] — An array of specific mode page controls processed in sequence to modify the behavior of request processing - `name` string, required — Short name describing the page control. - `description` string — Optional additional description of the page control. - `mode` 'maintenance' | 'request' | 'response' — Set as 'maintenance' for maintenance mode page control. - `enabled` boolean — Enables or disables the page control. - `conditions` PageControlConditions — The conditions that cause a page control to trigger - … - `actions` PageControlAction[], required — Actions that are applied when the page control is triggered. - … - `request_timeout` integer — Time for which Webscale proxy will wait for a backend server to respond. If proxy does not receive response in a specified time from the backend server, a maintenance page with status 502 Bad Gateway will be returned - `shields` union[] — A list of href's referencing firewalls that can be enabled/disabled for the application. - union - … - `shields_include_whitelist` boolean — Add whitelist addresses to shields. By default whitelist addresses are not added to the shields. Google cloud supports only IPv4 addresses in their firewall rules. Any IPv6 addresses in the whitelist will not be added to the firewall rules for Google. AWS supports both IPv4 and IPv6 addresses in the security groups - `site_cache` union - unknown - SiteCache — A configuration for Dynamic Site Cache - … - `trusted_proxies` union - unknown - AddressSetHref[] — Trust only the referenced peers. The client address from the X-Forwarded-For header is accepted provided that the peer address is in one of the referenced sets, but otherwise ignored. If the array is empty, then no proxies are trusted and the X-Forwarded-For header is ignored. - `data_planes` string[] — Configured data planes - `trusted_proxies_only` boolean — Allows external traffic only from addresses from the configured trusted proxies, the control addresses, and pingdom. - `trusted_proxies_header` string — The name of the header from a trusted proxy that is used to obtain the request address. When not set, X-Forwarded-For is used. - `labels` Label[] — Array of labels that will be attached to the application. - `translate_path` 'preserve' | 'unescape' — Configuration to specify the handling of URL paths through the Webscale proxy. The default behavior is to leave the path value untouched (preserve). A value of 'unescape' would remove all escaped characters in the path and replace them with their equivalent unicode character. - `pagespeed_disallow` string[] — A set of URL patterns to exclude from pagespeed optimization - `pagespeed_exclude_agents` string — User agents that match this regular expression are excluded from pagespeed - `pagespeed_map_proxy_domains` string[] — A set of domains that are integrated into the pages for this site - `microsite` string — Endpoint resource reference to a file. - `web_controls` WebControlConfiguration[] — An array of specific mode web controls processed in sequence to modify the behavior of request processing - `name` string, required — Short name describing the web control. - `description` string — Optional additional description of the web control. - `mode` 'maintenance' | 'request' | 'response' — Set as 'maintenance' for maintenance mode web control. - `enabled` boolean — Enables or disables the web control. - `conditions` WebControlCondition[] — An array of conditions. When empty, all requests match - … - `actions` PageControlAction[], required — Actions that are applied when the web control is triggered. - … - `stratus_id` union - unknown - string — Identification for stratus applications - `log_retention` ApplicationLogRetention[] — An array of application log retention configuration objects - `type` 'default' | 'cdn' | 'custom' | 'csp-reports' | 'pageviews' | 'proxy-logs', required — Type of log retention - `online_days` integer — Number of online days - `archive_days` integer — Number of archive days - `online_space_allowance` integer — Allowance for online space - `archive_space_allowance` integer — Allowance for archive space - object - `name` string - `minimum_size` integer — An integer of value 0 or more. - `maximum_size` integer — An integer of value 0 or more. - `manual_size` union — The explicit size that a cluster will scale to. Overrides automatic size. - unknown - integer — An integer of value 0 or more. - `instance_type` 'micro' | 'small' | 'medium' | 'large' | 'xlarge' — Specifies the type (size) of instances to be created. - `scale_in_conditions` ScalingCondition[] — When any of these conditions become true for a server, then the cluster automatic size will be reduced by one. - `series_name` 'cpu_percent' | 'iowait_percent' | 'kilobytes_per_second' | 'loadavg_norm' | 'memory_used_percent' | 'requests_per_second', required — Name identifying the scaling condition type. - `operator` 'has_been_greater_than' | 'will_be_greater_than' | 'has_been_less_than' | 'will_be_less_than', required — Operator to determine scaling condition. - `value` number, required — Threshold value to trigger scaling in or out of servers. - `duration` integer, required — An integer of value 0 or more. - `display_unit` 'seconds' | 'minutes' | 'hours', required — Unit to use for displaying the time duration specified. - `scale_out_conditions` ScalingCondition[] — When any of these conditions become true for a server, then the cluster automatic size will be increased by one. - `series_name` 'cpu_percent' | 'iowait_percent' | 'kilobytes_per_second' | 'loadavg_norm' | 'memory_used_percent' | 'requests_per_second', required — Name identifying the scaling condition type. - `operator` 'has_been_greater_than' | 'will_be_greater_than' | 'has_been_less_than' | 'will_be_less_than', required — Operator to determine scaling condition. - `value` number, required — Threshold value to trigger scaling in or out of servers. - `duration` integer, required — An integer of value 0 or more. - `display_unit` 'seconds' | 'minutes' | 'hours', required — Unit to use for displaying the time duration specified. - `server_blueprints` Blueprint[] — Specifies how servers in this cluster are to be built. - `files` MetadataFileEntry[] — A set of files to be made available on servers created with this blueprint. - … - `identity` IdentityConfiguration — Configuration of the identity assigned to cluster servers. - … - `image` string — Resource href that includes the Webscale provider identifier. - `instance_template` string — The endpoint resource identifier for the instance template. - `instance_type` string — Resource href that includes the Webscale provider identifier. - `metadata` MetadataEntry[] — A set of key/value pairs that will be provided to servers created with this blueprint. Server blueprint metadata overrides the cluster metadata on a key-by-key basis. - … - `networks` ProviderResourceHref[] — List of network or subnet endpoint resource references to associate the server with. Network availability may be limited to specific zones depending on the cloud provider. - `network_tags` string[] — List of network tags to associate with the server. Only applicable for Google provider. - `placement` union - … - `provider` Provider - … - `security_groups` SecurityGroupHref[] — List of security group endpoint resource references to associate with the server. Only applicable for AWS provider. - `storage_account` string — Resource href that includes the Webscale provider identifier. - `zone` string — Resource href that includes the Webscale provider identifier. - `bootstrap` BootstrapConfiguration - `file` string, required — Endpoint resource reference to a file. - `command` string, required — Cloud Init command to run once the server is commissioned. - `minimum_increment` integer — An integer of value 1 or more. - `server_failure_timeout` integer — An integer of value 0 or more. - `servers_update_webhook` string, uri — An HTTP URL address. - `verify_timeout` integer — The time to wait for a new server to verify. If a server does not respond to a GET / with a non-5xx status code after this many seconds, then it fails verification and will be replaced or destroyed - `failed_server_disposition` 'destroy' | 'detach' — If set to detach, failed servers won't be deleted from cloud provider after deletion. - `allocate_public_address` boolean — When set to true, server will have a public address associated with it. If set to false, the server will not have public address. Before making this change, please make sure that the proxy and servers with private addresses are in the same network. NOTE: As of now, this functionality is only supported for Centurylink cloud. - `measurement_type` 'none' | 'lg-status' | 'self-reporting' — When self-reporting, server will post its measurements to /v2/servers/metrics periodically. When lg-status, server needs to be installed with lg_mod_status and Webscale will pull the measurements from the server periodically. When none, Webscale will not monitor the cluster - `checks` Check[] — List of checks that needs to be performed to verify cluster server. - `url` string, uri, required — URL to perform server verification on. - `allowed_status_code` string, regex — Regular expression to check the status code for responses to verification requests, when it is not satisfied the check will be deemed as a failure. Defaults to '/^[23]/' - `body` string — Request body which needs to be sent with verification request. Defaults to empty string. - `headers` Header[] — Array of headers that needs to be included in the verification request. Defaults to no headers. - … - `permitted_redirect_hosts` Alias[] — A list of host names to follow when redirect responses are received during verification. Defaults to empty list. - `prohibit_content` string, regex — A regular expression applied on the response body that if matched fails the check. Defaults to no regular expression. - `request_method` string — HTTP request method to use when sending verification requests. Defaults to 'GET' - `require_content` string, regex — A regular expression applied on the response body that must match for the check to succeed. Defaults to no regular expression. - `timeout` integer — Number of seconds to wait for the response from server. Defaults to 30 seconds. - `verify_certificates` boolean — Flag when set to true directs the check to verify the validity of the offered certificates. Defaults to true. - `metadata` MetadataEntry[] — A set of key/value pairs that will be provided to servers created in this cluster. Server blueprint metadata overrides the cluster metadata on a key-by-key basis. - `key` string — A key name. - `value` string — A value associated with the given key. - `files` MetadataFileEntry[] — A set of files to be made available on servers created with this blueprint. Server blueprint files overrides cluster files on a key-by-key basis. - `file` string — A reference to a Webscale file. - `path` string — The absolute path where the file is made available on a server made with this blueprint. - object — A generic configuration model object that is to be used when an object specific configuration model schema is not found. - EventDeleteDetails — Event log details of type delete - `snapshot` union, required - object - `name` string — The name of the application. - `aliases` string[] — Ordered array of application domain names. The first array entry will be used as the primary application domain name. - `bot_management` BotManagement - `user_agent` boolean, required — When set to true, bot identification takes place using user-agent of the request. - `cdn_aliases` string[] — Array of application domain names published to CDN. - `components` Component[] — List of resource layers that are attached to this application. Examples of such resources include EC2 or RDS instances available in an AWS cloud provider. - `layer_name` string — Name of the resource layer being referenced here. - `element` string — The endpoint for a resource accessible via services available for this account. - `cdn_configuration` CdnConfiguration - `controls` CdnControl[], required — Array of cdn controls to be configured with the cdn distribution. - … - `cdn_ready` boolean — True when a delivery = cdn has been configured and is ready. - `cdn_service` string — A href to the cdn service configured for the application. - `default_hostname` string — Alias for an application - `dns_service` string, nullable — A href to the dns service configured for the application. - `servers_hostname` union - unknown - string — A fully qualified domain name (FQD) whose addresses are used to set the backend servers to which traffic should be sent - `delivery` 'cdn' | 'rewrite-to-cdn' | 'without-cdn' — The mode of delivery for an application. One of 'cdn', 'without-cdn', or 'rewrite-to-cdn'. The 'rewrite-to-cdn' mode is not recommended for new applications - `enable_cdn` boolean — Enable CDN for the application. This is not used if the 'delivery' attribute is set - `enable_http2` boolean — Enable HTTP2 for the application. - `enable_rum` boolean — Enable RUM for the application. - `enable_tls` boolean — Enable TLS for the application. The tls_configuration is required if true. - `tls_configuration` TlsConfiguration - `private_key` union — A reference to a secret containing a private key - … - `private_keys` union[] — A reference to an array of secrets containing private keys - … - `certificate_chain` string — The signed certificate followed by any intermediate certificate chain. - `enable_auto_tls` boolean — When enabled Auto TLS will configure your application to automatically obtain and renew certificates from Let's Encrypt. - `enable_force_tls` boolean — Force HTTP traffic to be routed over HTTPS for the application. - `enable_tls_offloading` boolean — When enabled the ADC tier will act as a TLS termination proxy, decrypting incoming HTTPS traffic and routing the unencrypted traffic to the application tier over HTTP. Response from the application tier are encrypted at the ADC tier and routed over HTTPS back to the client. - `enable_server_validation` boolean — Enable validation of the TLS certificate chain against the application servers. - `tolerate_invalid_chain` boolean — Tolerate certificate chain errors in certificates presented by the application servers. - `versions` TlsVersion[] — The versions of TLS that will be accepted for this application - `covered_aliases` CoveredAlias[] — Covered aliases by tls configuration for this application - … - `metrics` MetricConfiguration[] — Array of metric configurations attached for the application - `name` string — Name of the metric - `frequency` integer — Frequency at which metrics are populated - `prototype` string, required — A reference to the metric prototype - `monitoring` 'none' | 'passive' | 'active' — The monitoring mode. When active, the application will be monitored regularly from a separate location, in addition to passive monitoring. When passive, the error rate for the application is monitored and used to generate alerts, but if there is no regular activity to the application, then no outage will be detected. - `waf_rules` WafFileReference[] — The waf rules for the application. - `file` ResourceReference, required - … - `name` string, required — The name of the waf rule. - `created` string, date-time — The timestamp when a waf rule was uploaded. - `active` integer, required — Indicates if the waf rule is active or not. 1 represents active and 0 is inactive. - `whitelist` AddressSetEntry[] — A list of addresses to always be allowed access. - `created` string — An iso8601 formatted timestamp - `created_by` string — Reference to the user that created this id - `description` string — Description of the address - `address` string, required — A ip address or range. - `expiry` string — An iso8601 formatted timestamp - `whitelist_href` string — The endpoint for an address set resource - `blacklist` AddressSetEntry[] — A list of addresses to be restricted access. - `created` string — An iso8601 formatted timestamp - `created_by` string — Reference to the user that created this id - `description` string — Description of the address - `address` string, required — A ip address or range. - `expiry` string — An iso8601 formatted timestamp - `blacklist_href` string — The endpoint for an address set resource - `blacklist_user_agents` string, nullable — A regular expression of user agents to be restricted access. - `concurrent_limit` integer — Maximum number of concurrently active requests that can be run in a load balancer before requests are put in the suspend queue. This attribute may only be set by system administrators - `maximum_queue_time` integer — Maximum amount of time a request can spend in the suspend queue of a load balancer before it is failed with a timeout. This attribute may only be set by system administrators - `merge_slashes` boolean — Controls whether the server merges consecutive slashes in URLs. By default, consecutive slashes are merged into a single slash. - `suspend_limit` integer — Maximum number of requests that can be put in the suspend queue of a load balancer before the oldest requests are failed. This attribute may only be set by system administrators - `probes` string[] - `protection` 'normal' | 'maximum' — The protection mode. - `protection_captcha_retry_limit` integer — Number of incorrect attempts a user is allowed before the user may be blacklisted. - `protection_blacklist_timeout` integer — Number of seconds to enforce blacklist on the suspicious user. - `protection_microsite_file` string — Endpoint for the file id associated with the captcha microsite. - `cluster` string, nullable — The endpoint for the cluster resource. - `servers` union - unknown - ApplicationServer[] — Application static servers. - … - `page_controls` PageControlConfiguration[] — An array of specific mode page controls processed in sequence to modify the behavior of request processing - `name` string, required — Short name describing the page control. - `description` string — Optional additional description of the page control. - `mode` 'maintenance' | 'request' | 'response' — Set as 'maintenance' for maintenance mode page control. - `enabled` boolean — Enables or disables the page control. - `conditions` PageControlConditions — The conditions that cause a page control to trigger - … - `actions` PageControlAction[], required — Actions that are applied when the page control is triggered. - … - `request_timeout` integer — Time for which Webscale proxy will wait for a backend server to respond. If proxy does not receive response in a specified time from the backend server, a maintenance page with status 502 Bad Gateway will be returned - `shields` union[] — A list of href's referencing firewalls that can be enabled/disabled for the application. - union - … - `shields_include_whitelist` boolean — Add whitelist addresses to shields. By default whitelist addresses are not added to the shields. Google cloud supports only IPv4 addresses in their firewall rules. Any IPv6 addresses in the whitelist will not be added to the firewall rules for Google. AWS supports both IPv4 and IPv6 addresses in the security groups - `site_cache` union - unknown - SiteCache — A configuration for Dynamic Site Cache - … - `trusted_proxies` union - unknown - AddressSetHref[] — Trust only the referenced peers. The client address from the X-Forwarded-For header is accepted provided that the peer address is in one of the referenced sets, but otherwise ignored. If the array is empty, then no proxies are trusted and the X-Forwarded-For header is ignored. - `data_planes` string[] — Configured data planes - `trusted_proxies_only` boolean — Allows external traffic only from addresses from the configured trusted proxies, the control addresses, and pingdom. - `trusted_proxies_header` string — The name of the header from a trusted proxy that is used to obtain the request address. When not set, X-Forwarded-For is used. - `labels` Label[] — Array of labels that will be attached to the application. - `translate_path` 'preserve' | 'unescape' — Configuration to specify the handling of URL paths through the Webscale proxy. The default behavior is to leave the path value untouched (preserve). A value of 'unescape' would remove all escaped characters in the path and replace them with their equivalent unicode character. - `pagespeed_disallow` string[] — A set of URL patterns to exclude from pagespeed optimization - `pagespeed_exclude_agents` string — User agents that match this regular expression are excluded from pagespeed - `pagespeed_map_proxy_domains` string[] — A set of domains that are integrated into the pages for this site - `microsite` string — Endpoint resource reference to a file. - `web_controls` WebControlConfiguration[] — An array of specific mode web controls processed in sequence to modify the behavior of request processing - `name` string, required — Short name describing the web control. - `description` string — Optional additional description of the web control. - `mode` 'maintenance' | 'request' | 'response' — Set as 'maintenance' for maintenance mode web control. - `enabled` boolean — Enables or disables the web control. - `conditions` WebControlCondition[] — An array of conditions. When empty, all requests match - … - `actions` PageControlAction[], required — Actions that are applied when the web control is triggered. - … - `stratus_id` union - unknown - string — Identification for stratus applications - `log_retention` ApplicationLogRetention[] — An array of application log retention configuration objects - `type` 'default' | 'cdn' | 'custom' | 'csp-reports' | 'pageviews' | 'proxy-logs', required — Type of log retention - `online_days` integer — Number of online days - `archive_days` integer — Number of archive days - `online_space_allowance` integer — Allowance for online space - `archive_space_allowance` integer — Allowance for archive space - object - `name` string - `minimum_size` integer — An integer of value 0 or more. - `maximum_size` integer — An integer of value 0 or more. - `manual_size` union — The explicit size that a cluster will scale to. Overrides automatic size. - unknown - integer — An integer of value 0 or more. - `instance_type` 'micro' | 'small' | 'medium' | 'large' | 'xlarge' — Specifies the type (size) of instances to be created. - `scale_in_conditions` ScalingCondition[] — When any of these conditions become true for a server, then the cluster automatic size will be reduced by one. - `series_name` 'cpu_percent' | 'iowait_percent' | 'kilobytes_per_second' | 'loadavg_norm' | 'memory_used_percent' | 'requests_per_second', required — Name identifying the scaling condition type. - `operator` 'has_been_greater_than' | 'will_be_greater_than' | 'has_been_less_than' | 'will_be_less_than', required — Operator to determine scaling condition. - `value` number, required — Threshold value to trigger scaling in or out of servers. - `duration` integer, required — An integer of value 0 or more. - `display_unit` 'seconds' | 'minutes' | 'hours', required — Unit to use for displaying the time duration specified. - `scale_out_conditions` ScalingCondition[] — When any of these conditions become true for a server, then the cluster automatic size will be increased by one. - `series_name` 'cpu_percent' | 'iowait_percent' | 'kilobytes_per_second' | 'loadavg_norm' | 'memory_used_percent' | 'requests_per_second', required — Name identifying the scaling condition type. - `operator` 'has_been_greater_than' | 'will_be_greater_than' | 'has_been_less_than' | 'will_be_less_than', required — Operator to determine scaling condition. - `value` number, required — Threshold value to trigger scaling in or out of servers. - `duration` integer, required — An integer of value 0 or more. - `display_unit` 'seconds' | 'minutes' | 'hours', required — Unit to use for displaying the time duration specified. - `server_blueprints` Blueprint[] — Specifies how servers in this cluster are to be built. - `files` MetadataFileEntry[] — A set of files to be made available on servers created with this blueprint. - … - `identity` IdentityConfiguration — Configuration of the identity assigned to cluster servers. - … - `image` string — Resource href that includes the Webscale provider identifier. - `instance_template` string — The endpoint resource identifier for the instance template. - `instance_type` string — Resource href that includes the Webscale provider identifier. - `metadata` MetadataEntry[] — A set of key/value pairs that will be provided to servers created with this blueprint. Server blueprint metadata overrides the cluster metadata on a key-by-key basis. - … - `networks` ProviderResourceHref[] — List of network or subnet endpoint resource references to associate the server with. Network availability may be limited to specific zones depending on the cloud provider. - `network_tags` string[] — List of network tags to associate with the server. Only applicable for Google provider. - `placement` union - … - `provider` Provider - … - `security_groups` SecurityGroupHref[] — List of security group endpoint resource references to associate with the server. Only applicable for AWS provider. - `storage_account` string — Resource href that includes the Webscale provider identifier. - `zone` string — Resource href that includes the Webscale provider identifier. - `bootstrap` BootstrapConfiguration - `file` string, required — Endpoint resource reference to a file. - `command` string, required — Cloud Init command to run once the server is commissioned. - `minimum_increment` integer — An integer of value 1 or more. - `server_failure_timeout` integer — An integer of value 0 or more. - `servers_update_webhook` string, uri — An HTTP URL address. - `verify_timeout` integer — The time to wait for a new server to verify. If a server does not respond to a GET / with a non-5xx status code after this many seconds, then it fails verification and will be replaced or destroyed - `failed_server_disposition` 'destroy' | 'detach' — If set to detach, failed servers won't be deleted from cloud provider after deletion. - `allocate_public_address` boolean — When set to true, server will have a public address associated with it. If set to false, the server will not have public address. Before making this change, please make sure that the proxy and servers with private addresses are in the same network. NOTE: As of now, this functionality is only supported for Centurylink cloud. - `measurement_type` 'none' | 'lg-status' | 'self-reporting' — When self-reporting, server will post its measurements to /v2/servers/metrics periodically. When lg-status, server needs to be installed with lg_mod_status and Webscale will pull the measurements from the server periodically. When none, Webscale will not monitor the cluster - `checks` Check[] — List of checks that needs to be performed to verify cluster server. - `url` string, uri, required — URL to perform server verification on. - `allowed_status_code` string, regex — Regular expression to check the status code for responses to verification requests, when it is not satisfied the check will be deemed as a failure. Defaults to '/^[23]/' - `body` string — Request body which needs to be sent with verification request. Defaults to empty string. - `headers` Header[] — Array of headers that needs to be included in the verification request. Defaults to no headers. - … - `permitted_redirect_hosts` Alias[] — A list of host names to follow when redirect responses are received during verification. Defaults to empty list. - `prohibit_content` string, regex — A regular expression applied on the response body that if matched fails the check. Defaults to no regular expression. - `request_method` string — HTTP request method to use when sending verification requests. Defaults to 'GET' - `require_content` string, regex — A regular expression applied on the response body that must match for the check to succeed. Defaults to no regular expression. - `timeout` integer — Number of seconds to wait for the response from server. Defaults to 30 seconds. - `verify_certificates` boolean — Flag when set to true directs the check to verify the validity of the offered certificates. Defaults to true. - `metadata` MetadataEntry[] — A set of key/value pairs that will be provided to servers created in this cluster. Server blueprint metadata overrides the cluster metadata on a key-by-key basis. - `key` string — A key name. - `value` string — A value associated with the given key. - `files` MetadataFileEntry[] — A set of files to be made available on servers created with this blueprint. Server blueprint files overrides cluster files on a key-by-key basis. - `file` string — A reference to a Webscale file. - `path` string — The absolute path where the file is made available on a server made with this blueprint. - object — A generic configuration model object that is to be used when an object specific configuration model schema is not found. - EventUpdateDetails — Event log details of type update - `snapshot` union, required - object - `name` string — The name of the application. - `aliases` string[] — Ordered array of application domain names. The first array entry will be used as the primary application domain name. - `bot_management` BotManagement - `user_agent` boolean, required — When set to true, bot identification takes place using user-agent of the request. - `cdn_aliases` string[] — Array of application domain names published to CDN. - `components` Component[] — List of resource layers that are attached to this application. Examples of such resources include EC2 or RDS instances available in an AWS cloud provider. - `layer_name` string — Name of the resource layer being referenced here. - `element` string — The endpoint for a resource accessible via services available for this account. - `cdn_configuration` CdnConfiguration - `controls` CdnControl[], required — Array of cdn controls to be configured with the cdn distribution. - … - `cdn_ready` boolean — True when a delivery = cdn has been configured and is ready. - `cdn_service` string — A href to the cdn service configured for the application. - `default_hostname` string — Alias for an application - `dns_service` string, nullable — A href to the dns service configured for the application. - `servers_hostname` union - unknown - string — A fully qualified domain name (FQD) whose addresses are used to set the backend servers to which traffic should be sent - `delivery` 'cdn' | 'rewrite-to-cdn' | 'without-cdn' — The mode of delivery for an application. One of 'cdn', 'without-cdn', or 'rewrite-to-cdn'. The 'rewrite-to-cdn' mode is not recommended for new applications - `enable_cdn` boolean — Enable CDN for the application. This is not used if the 'delivery' attribute is set - `enable_http2` boolean — Enable HTTP2 for the application. - `enable_rum` boolean — Enable RUM for the application. - `enable_tls` boolean — Enable TLS for the application. The tls_configuration is required if true. - `tls_configuration` TlsConfiguration - `private_key` union — A reference to a secret containing a private key - … - `private_keys` union[] — A reference to an array of secrets containing private keys - … - `certificate_chain` string — The signed certificate followed by any intermediate certificate chain. - `enable_auto_tls` boolean — When enabled Auto TLS will configure your application to automatically obtain and renew certificates from Let's Encrypt. - `enable_force_tls` boolean — Force HTTP traffic to be routed over HTTPS for the application. - `enable_tls_offloading` boolean — When enabled the ADC tier will act as a TLS termination proxy, decrypting incoming HTTPS traffic and routing the unencrypted traffic to the application tier over HTTP. Response from the application tier are encrypted at the ADC tier and routed over HTTPS back to the client. - `enable_server_validation` boolean — Enable validation of the TLS certificate chain against the application servers. - `tolerate_invalid_chain` boolean — Tolerate certificate chain errors in certificates presented by the application servers. - `versions` TlsVersion[] — The versions of TLS that will be accepted for this application - `covered_aliases` CoveredAlias[] — Covered aliases by tls configuration for this application - … - `metrics` MetricConfiguration[] — Array of metric configurations attached for the application - `name` string — Name of the metric - `frequency` integer — Frequency at which metrics are populated - `prototype` string, required — A reference to the metric prototype - `monitoring` 'none' | 'passive' | 'active' — The monitoring mode. When active, the application will be monitored regularly from a separate location, in addition to passive monitoring. When passive, the error rate for the application is monitored and used to generate alerts, but if there is no regular activity to the application, then no outage will be detected. - `waf_rules` WafFileReference[] — The waf rules for the application. - `file` ResourceReference, required - … - `name` string, required — The name of the waf rule. - `created` string, date-time — The timestamp when a waf rule was uploaded. - `active` integer, required — Indicates if the waf rule is active or not. 1 represents active and 0 is inactive. - `whitelist` AddressSetEntry[] — A list of addresses to always be allowed access. - `created` string — An iso8601 formatted timestamp - `created_by` string — Reference to the user that created this id - `description` string — Description of the address - `address` string, required — A ip address or range. - `expiry` string — An iso8601 formatted timestamp - `whitelist_href` string — The endpoint for an address set resource - `blacklist` AddressSetEntry[] — A list of addresses to be restricted access. - `created` string — An iso8601 formatted timestamp - `created_by` string — Reference to the user that created this id - `description` string — Description of the address - `address` string, required — A ip address or range. - `expiry` string — An iso8601 formatted timestamp - `blacklist_href` string — The endpoint for an address set resource - `blacklist_user_agents` string, nullable — A regular expression of user agents to be restricted access. - `concurrent_limit` integer — Maximum number of concurrently active requests that can be run in a load balancer before requests are put in the suspend queue. This attribute may only be set by system administrators - `maximum_queue_time` integer — Maximum amount of time a request can spend in the suspend queue of a load balancer before it is failed with a timeout. This attribute may only be set by system administrators - `merge_slashes` boolean — Controls whether the server merges consecutive slashes in URLs. By default, consecutive slashes are merged into a single slash. - `suspend_limit` integer — Maximum number of requests that can be put in the suspend queue of a load balancer before the oldest requests are failed. This attribute may only be set by system administrators - `probes` string[] - `protection` 'normal' | 'maximum' — The protection mode. - `protection_captcha_retry_limit` integer — Number of incorrect attempts a user is allowed before the user may be blacklisted. - `protection_blacklist_timeout` integer — Number of seconds to enforce blacklist on the suspicious user. - `protection_microsite_file` string — Endpoint for the file id associated with the captcha microsite. - `cluster` string, nullable — The endpoint for the cluster resource. - `servers` union - unknown - ApplicationServer[] — Application static servers. - … - `page_controls` PageControlConfiguration[] — An array of specific mode page controls processed in sequence to modify the behavior of request processing - `name` string, required — Short name describing the page control. - `description` string — Optional additional description of the page control. - `mode` 'maintenance' | 'request' | 'response' — Set as 'maintenance' for maintenance mode page control. - `enabled` boolean — Enables or disables the page control. - `conditions` PageControlConditions — The conditions that cause a page control to trigger - … - `actions` PageControlAction[], required — Actions that are applied when the page control is triggered. - … - `request_timeout` integer — Time for which Webscale proxy will wait for a backend server to respond. If proxy does not receive response in a specified time from the backend server, a maintenance page with status 502 Bad Gateway will be returned - `shields` union[] — A list of href's referencing firewalls that can be enabled/disabled for the application. - union - … - `shields_include_whitelist` boolean — Add whitelist addresses to shields. By default whitelist addresses are not added to the shields. Google cloud supports only IPv4 addresses in their firewall rules. Any IPv6 addresses in the whitelist will not be added to the firewall rules for Google. AWS supports both IPv4 and IPv6 addresses in the security groups - `site_cache` union - unknown - SiteCache — A configuration for Dynamic Site Cache - … - `trusted_proxies` union - unknown - AddressSetHref[] — Trust only the referenced peers. The client address from the X-Forwarded-For header is accepted provided that the peer address is in one of the referenced sets, but otherwise ignored. If the array is empty, then no proxies are trusted and the X-Forwarded-For header is ignored. - `data_planes` string[] — Configured data planes - `trusted_proxies_only` boolean — Allows external traffic only from addresses from the configured trusted proxies, the control addresses, and pingdom. - `trusted_proxies_header` string — The name of the header from a trusted proxy that is used to obtain the request address. When not set, X-Forwarded-For is used. - `labels` Label[] — Array of labels that will be attached to the application. - `translate_path` 'preserve' | 'unescape' — Configuration to specify the handling of URL paths through the Webscale proxy. The default behavior is to leave the path value untouched (preserve). A value of 'unescape' would remove all escaped characters in the path and replace them with their equivalent unicode character. - `pagespeed_disallow` string[] — A set of URL patterns to exclude from pagespeed optimization - `pagespeed_exclude_agents` string — User agents that match this regular expression are excluded from pagespeed - `pagespeed_map_proxy_domains` string[] — A set of domains that are integrated into the pages for this site - `microsite` string — Endpoint resource reference to a file. - `web_controls` WebControlConfiguration[] — An array of specific mode web controls processed in sequence to modify the behavior of request processing - `name` string, required — Short name describing the web control. - `description` string — Optional additional description of the web control. - `mode` 'maintenance' | 'request' | 'response' — Set as 'maintenance' for maintenance mode web control. - `enabled` boolean — Enables or disables the web control. - `conditions` WebControlCondition[] — An array of conditions. When empty, all requests match - … - `actions` PageControlAction[], required — Actions that are applied when the web control is triggered. - … - `stratus_id` union - unknown - string — Identification for stratus applications - `log_retention` ApplicationLogRetention[] — An array of application log retention configuration objects - `type` 'default' | 'cdn' | 'custom' | 'csp-reports' | 'pageviews' | 'proxy-logs', required — Type of log retention - `online_days` integer — Number of online days - `archive_days` integer — Number of archive days - `online_space_allowance` integer — Allowance for online space - `archive_space_allowance` integer — Allowance for archive space - object - `name` string - `minimum_size` integer — An integer of value 0 or more. - `maximum_size` integer — An integer of value 0 or more. - `manual_size` union — The explicit size that a cluster will scale to. Overrides automatic size. - unknown - integer — An integer of value 0 or more. - `instance_type` 'micro' | 'small' | 'medium' | 'large' | 'xlarge' — Specifies the type (size) of instances to be created. - `scale_in_conditions` ScalingCondition[] — When any of these conditions become true for a server, then the cluster automatic size will be reduced by one. - `series_name` 'cpu_percent' | 'iowait_percent' | 'kilobytes_per_second' | 'loadavg_norm' | 'memory_used_percent' | 'requests_per_second', required — Name identifying the scaling condition type. - `operator` 'has_been_greater_than' | 'will_be_greater_than' | 'has_been_less_than' | 'will_be_less_than', required — Operator to determine scaling condition. - `value` number, required — Threshold value to trigger scaling in or out of servers. - `duration` integer, required — An integer of value 0 or more. - `display_unit` 'seconds' | 'minutes' | 'hours', required — Unit to use for displaying the time duration specified. - `scale_out_conditions` ScalingCondition[] — When any of these conditions become true for a server, then the cluster automatic size will be increased by one. - `series_name` 'cpu_percent' | 'iowait_percent' | 'kilobytes_per_second' | 'loadavg_norm' | 'memory_used_percent' | 'requests_per_second', required — Name identifying the scaling condition type. - `operator` 'has_been_greater_than' | 'will_be_greater_than' | 'has_been_less_than' | 'will_be_less_than', required — Operator to determine scaling condition. - `value` number, required — Threshold value to trigger scaling in or out of servers. - `duration` integer, required — An integer of value 0 or more. - `display_unit` 'seconds' | 'minutes' | 'hours', required — Unit to use for displaying the time duration specified. - `server_blueprints` Blueprint[] — Specifies how servers in this cluster are to be built. - `files` MetadataFileEntry[] — A set of files to be made available on servers created with this blueprint. - … - `identity` IdentityConfiguration — Configuration of the identity assigned to cluster servers. - … - `image` string — Resource href that includes the Webscale provider identifier. - `instance_template` string — The endpoint resource identifier for the instance template. - `instance_type` string — Resource href that includes the Webscale provider identifier. - `metadata` MetadataEntry[] — A set of key/value pairs that will be provided to servers created with this blueprint. Server blueprint metadata overrides the cluster metadata on a key-by-key basis. - … - `networks` ProviderResourceHref[] — List of network or subnet endpoint resource references to associate the server with. Network availability may be limited to specific zones depending on the cloud provider. - `network_tags` string[] — List of network tags to associate with the server. Only applicable for Google provider. - `placement` union - … - `provider` Provider - … - `security_groups` SecurityGroupHref[] — List of security group endpoint resource references to associate with the server. Only applicable for AWS provider. - `storage_account` string — Resource href that includes the Webscale provider identifier. - `zone` string — Resource href that includes the Webscale provider identifier. - `bootstrap` BootstrapConfiguration - `file` string, required — Endpoint resource reference to a file. - `command` string, required — Cloud Init command to run once the server is commissioned. - `minimum_increment` integer — An integer of value 1 or more. - `server_failure_timeout` integer — An integer of value 0 or more. - `servers_update_webhook` string, uri — An HTTP URL address. - `verify_timeout` integer — The time to wait for a new server to verify. If a server does not respond to a GET / with a non-5xx status code after this many seconds, then it fails verification and will be replaced or destroyed - `failed_server_disposition` 'destroy' | 'detach' — If set to detach, failed servers won't be deleted from cloud provider after deletion. - `allocate_public_address` boolean — When set to true, server will have a public address associated with it. If set to false, the server will not have public address. Before making this change, please make sure that the proxy and servers with private addresses are in the same network. NOTE: As of now, this functionality is only supported for Centurylink cloud. - `measurement_type` 'none' | 'lg-status' | 'self-reporting' — When self-reporting, server will post its measurements to /v2/servers/metrics periodically. When lg-status, server needs to be installed with lg_mod_status and Webscale will pull the measurements from the server periodically. When none, Webscale will not monitor the cluster - `checks` Check[] — List of checks that needs to be performed to verify cluster server. - `url` string, uri, required — URL to perform server verification on. - `allowed_status_code` string, regex — Regular expression to check the status code for responses to verification requests, when it is not satisfied the check will be deemed as a failure. Defaults to '/^[23]/' - `body` string — Request body which needs to be sent with verification request. Defaults to empty string. - `headers` Header[] — Array of headers that needs to be included in the verification request. Defaults to no headers. - … - `permitted_redirect_hosts` Alias[] — A list of host names to follow when redirect responses are received during verification. Defaults to empty list. - `prohibit_content` string, regex — A regular expression applied on the response body that if matched fails the check. Defaults to no regular expression. - `request_method` string — HTTP request method to use when sending verification requests. Defaults to 'GET' - `require_content` string, regex — A regular expression applied on the response body that must match for the check to succeed. Defaults to no regular expression. - `timeout` integer — Number of seconds to wait for the response from server. Defaults to 30 seconds. - `verify_certificates` boolean — Flag when set to true directs the check to verify the validity of the offered certificates. Defaults to true. - `metadata` MetadataEntry[] — A set of key/value pairs that will be provided to servers created in this cluster. Server blueprint metadata overrides the cluster metadata on a key-by-key basis. - `key` string — A key name. - `value` string — A value associated with the given key. - `files` MetadataFileEntry[] — A set of files to be made available on servers created with this blueprint. Server blueprint files overrides cluster files on a key-by-key basis. - `file` string — A reference to a Webscale file. - `path` string — The absolute path where the file is made available on a server made with this blueprint. - object — A generic configuration model object that is to be used when an object specific configuration model schema is not found. - `change` JsonPatchOperation[], required — An array of JSON patch operations as defined by RFC 6902 - `op` 'add' | 'remove' | 'replace' | 'move' | 'copy' | 'test', required — The operation to be performed - `path` string, required — A JSON-Pointer - `value` union — The value to be used within the operations. - boolean - string - unknown[] - unknown - object - number - `from` string — A string containing a JSON Pointer value. - AnyObject — Any JSON object. - `incident` string, required — The identifier for the underlying incident that triggered the event. - `message` string, required — Text that describes the occurrence of an event. - `severity` 'info' | 'severe' | 'warning', required — The severity of the event. There are three levels: info is informational and no action is needed, warning may indicate that an error will occur if action is not taken, severe is critical and requires immediate attention (e.g. the application is down). - `subject` string — The object that is affected by the event (e.g. A cluster scale out event for cluster w234fs will have a subject of /v2/cluster/w234fs). - `type` string, required — The type of event that has occurred. - `origin` string — The third-party entity that generated the event. - `originated` string — An iso8601 formatted timestamp --- [API](https://skmtc.dev/webscale/apis/webscale-apis.md) · [All operations](https://skmtc.dev/webscale/apis/webscale-apis/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/webscale/webscale-apis/revisions/c98d872b50cb/schema)