Automate HTTPS App Config Updates with ESA API - Edge Security Acceleration

Update the HTTPS Application Configuration.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

No authorization for this operation. If you encounter issues with this operation, contact technical support.

Request parameters

Parameter	Type	Required	Description	Example
SiteId	integer	Yes	The site ID. To obtain this ID, call the ListSites API.	123456****
ConfigId	integer	Yes	The configuration ID.	35281609698****
RuleName	string	No	The rule name. This parameter is not required for a global configuration.	rule_example
RuleEnable	string	No	Specifies whether to enable the rule. This parameter is not required for a global configuration. Valid values: `on`: Enables the rule. `off`: Disables the rule.	on
Rule	string	No	The conditional expression that the rule uses to match requests. This parameter is not required for a global configuration. To match all incoming requests, set the value to `true`. To match specific requests, provide a custom expression, such as `(http.host eq "video.example.com")`	(http.host eq \"video.example.com\")
HttpsForce	string	No	Specifies whether to enable Force HTTPS. This feature is disabled by default. Valid values: `on`: Enables Force HTTPS. `off`: Disables Force HTTPS.	on
HttpsForceCode	string	No	The redirect status code for Force HTTPS. Valid values: `301` `302` `307` `308`	301
AltSvc	string	No	Specifies whether to enable the `Alt-Svc` header. This feature is disabled by default. Valid values: `on`: Enables the Alt-Svc header. `off`: Disables the Alt-Svc header.	on
AltSvcClear	string	No	Specifies whether to include the `clear` directive in the `Alt-Svc` header. The directive is not included by default. Valid values: `on`: Includes the directive. `off`: Does not include the directive.	on
AltSvcPersist	string	No	Specifies whether to include the `persist` directive in the `Alt-Svc` header. The directive is not included by default. Valid values: `on`: Includes the directive. `off`: Does not include the directive.	on
AltSvcMa	string	No	The max-age for the Alt-Svc header, in seconds. The default is 86400.	86400
Hsts	string	No	Specifies whether to enable HTTP Strict Transport Security (HSTS). This feature is disabled by default. Valid values: `on`: Enables HSTS. `off`: Disables HSTS.	on
HstsMaxAge	string	No	The HSTS max-age in seconds.	3600
HstsIncludeSubdomains	string	No	Specifies whether to include subdomains in the HSTS policy. Subdomains are not included by default. Valid values: `on`: Includes subdomains. `off`: Does not include subdomains.	on
HstsPreload	string	No	Specifies whether to enable HSTS Preload. HSTS Preload is disabled by default. Valid values: `on`: Enables Preload. `off`: Disables Preload.	on
Sequence	integer	No	The execution order of the rule. A lower value indicates a higher priority.	1
HttpsSniVerify	string	No	Specifies whether to enable Server Name Indication (SNI) verification. This feature is disabled by default. Valid values: `on`: Enables SNI verification. `off`: Disables SNI verification.	on
HttpsNoSniDeny	string	No	Specifies whether to deny TLS handshake requests that do not include an SNI. This feature is disabled by default. Valid values: `on`: Denies requests without an SNI. `off`: Allows requests without an SNI.	on
HttpsSniWhitelist	string	No	The SNI allowlist. Separate multiple hostnames with spaces.	abc edf

Response elements

Element	Type	Description	Example
	object	The response object.
RequestId	string	The request ID.	35C66C7B-671H-4297-9187-2C4477247A78

Examples

Success response

JSON format

{
  "RequestId": "35C66C7B-671H-4297-9187-2C4477247A78"
}

Error codes

HTTP status code	Error code	Error message	Description
400	CanNotSetSequence	Non-regular configuration, you cannot set Sequence parameters.	Sequence parameters is not allowed in global configuration.
400	CacheReserveSiteExceedLimit	The number of binding sites of the cache reserve instance exceeds the limit. The number of binding sites of a single cache reserve instance is limited. Please see the document for the limit.	The number of sites for which the cache reserve instance bindings exceeds the limit.
400	CompileRuleError	Rule compilation failed, please check the rule information passed in to ensure that the rule is written according to the syntax described in the document.	Rule compilation failed. Check the incoming rule configuration. For details, see the rule configuration format described in the interface document.
400	SiteConfigLengthExceedLimit	The overall configuration size of the site exceeds the limit, and the total size of all functional configurations of the site cannot exceed 512K.	The size of the site configuration exceeds the limit, and the total size cannot exceed 512K.
400	ConfigConflicts	Configuration conflicts, usually when multiple configurations are configured under the same function of the same site, such as duplicate rule names between multiple configurations.	The parameter uniqueness check failed. Check for duplicate parameter values.
400	RuleRegexQuotaCheckFailed	When configuring rules, rules with regular expressions are not allowed in this plan. Please check the relevant documentation of the plan or upgrade the plan.	The current plan does not support the configuration of a rule engine with a regular expression. Please check the plan description and upgrade your plan.
400	NestedRuleQuotaCheckFailed	The nesting level of rules allowed by the plan failed to be verified. Please modify the nesting level of rules or upgrade the plan.	The number of embedded sub-conditions in the rule exceeds the plan limit. Please check the plan description and upgrade your plan.
400	ArgQuotaCheckFailed	The passed-in parameter value failed to verify the validity of the plan. Please check the plan document to obtain the range of parameters that can be configured for the site plan.	The current plan does not support the configuration of restricted parameters, please check the input parameters.
400	ServiceInvokeFailed	The call to the internal service failed. The engineer is resolving the problem. Please wait a moment before trying, or contact customer service for details.	Failed to call the service. Please try again later or contact customer service for details.
400	FunctionConflict	The feature configuration conflicts. Sites with version management enabled cannot configure this feature.	The currently configured function conflicts with other functions. If you need to configure, delete the conflicting function configurations first.
400	SpecifiedVersionReadOnly	The specified version number is read-only and cannot be modified.	The specified version number is read-only and cannot be modified.
400	VersionNotValid	The site does not have version management enabled, or the version number passed in does not exist.	The site does not have version management enabled, or the version number passed in does not exist.
400	InternalException	Failed to call the service. Try again later or contact technical support.	Failed to call the service. Try again later or contact technical support.
400	InvalidParameter.ArgName	Invalid ArgName. Check your website configuration parameters and make sure that they match the supported features and parameter names listed in the official documentation.	Invalid ArgName. Check your website configuration parameters and make sure that they match the supported features and parameter names listed in the official documentation.
400	InvalidParameter.ArgValue	Invalid parameter value. Check whether the value format and length meet the requirements.	Invalid parameter value. Check whether the value format and length meet the requirements.
400	InvalidParameter.Configs	Invalid parameter configurations. Check whether your feature configurations are in the valid format and comply with relevant requirements.	Invalid parameter configurations. Check whether your feature configurations are in the valid format and comply with relevant requirements.
400	InstanceNotExist	The instance does not exist. Check whether the specified instance ID is correct or whether the instance belongs to your account.	The instance does not exist. Check whether the specified instance ID is correct or whether the instance belongs to your account.
400	LockFailed	The system is handling requests you previously submitted. Try again later.	The system is handling requests you previously submitted. Try again later.
400	IllegalOperation.VersionManagement	The version management operation failed because incompatible features or environment settings are configured. Adjust your configurations and try again.	The version management operation failed because incompatible features or environment settings are configured. Adjust your configurations and try again.
400	QuotaCheckFailed.VersionManagement	Insufficient quota for version management. Contact technical support.	Insufficient quota for version management. Contact technical support.
400	InvalidConfigId	The input configuration ID: ConfigId it does not exist, query the existing configuration and its valid ConfigId through the ListSiteFunction.	The ConfigId does not exist.
400	Instance.NotOnline	Your plan is unavailable due to an overdue payment. Complete the payment first.	Your plan is unavailable due to an overdue payment. Complete the payment first.
400	FunctionQuotaCheckFailed	The quota verification for this function fails. It may be that the configuration of this function exceeds the limit of the site plan. Please check the plan introduction document corresponding to this site.	The current plan does not support the configuration of restricted functions, please check the plan related function description.
400	QuotaCheckFailed.FunctionArg	The specified feature parameter is not allowed in your plan, or the feature parameter configurations have reached the upper limit in your plan.	The specified feature parameter is not allowed in your plan, or the feature parameter configurations have reached the upper limit in your plan.
400	MissingParameter	The specified ArgName is required for this function.	When configuring a specific function, the required parameter is missing.
400	FunctionArgError	Failed to check the configured function parameters.	Failed to check the configured function parameters
404	SiteNotFound	The website does not exist or does not belong to you.	The website does not exist or does not belong to you.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.