Edit Redirection V2

This API is used to edit an existing redirection rule for a website acceleration service.

Request

Request-Line

PUT /cdn/v1.1/services/{serviceId}/redirections/{policyId} HTTP/1.1

Request Parameters

Path Parameters

Parameter	Type	Required	Description
serviceId	Integer	Mandatory	The unique identifier of the service.
policyId	Integer	Mandatory	The unique identifier of the redirection policy.

Body Parameters

Parameter	Type	Required	Description
policyName	String	Mandatory	Name of the redirection policy.
matches	Array	Mandatory	Matching configuration that determines which requests the rule applies to. See Matches for details.
redirectDestination	String	Mandatory	The destination URL to redirect to when the policy matches.
httpCode	Integer	Mandatory	HTTP status code for the redirect. Supported values: 301, 302.
priority	Integer	Mandatory	Priority weight for the rule. Rules with a higher weight take precedence. Must be a positive integer.
enabled	Boolean	Optional	Whether the policy is active. Default is true.

Object: Matches

Parameter	Type	Required	Description
	Array	Mandatory	See Match for details.

Object: Match

Parameter	Type	Required	Description
field	String	Mandatory	Which part of the request to match. Supported values: • req.path - Request path (excluding query string). • req.query - Request query parameters. • req.method - HTTP method (GET, POST, etc.). • client.ip - Client IP address. • req.host - Request host. • req.header.user-agent - User-Agent header. • req.header.cookie - Cookie header. • req.header.origin - Origin header. • req.header.via - Via header.
operator	String	Mandatory	Defines how to match the field. Supported values: • startswith - Succeeds if the field value matches one of the prefixes listed in patterns. • not_startswith - Matches if field value does not start with any of the specified prefixes. • istartswith - Case-independent version of startswith. • not_istartswith - Matches if the field value does not start with any of the specified prefixes, ignoring letter case differences. • regex - Succeeds if the field value matches one of the regexes listed in patterns. • equals - Succeeds if the field value matches one of the strings listed in patterns. • not_equals - Succeeds if the field value does not exactly match any of the specified strings. • iequals - Case-independent version of equals. • not_iequals - Succeeds if the field value does not exactly match any of the specified strings, ignoring letter case differences. • endswith - Succeeds if the field value ends with one of the strings listed in patterns. Useful e.g. to match file extensions like ".mp4". • not_endswith - Succeeds if the field value does not end with one of the strings listed in patterns. • iendswith - Case-independent version of endswith. • not_iendswith - Succeeds if the field value does not end with one of the strings listed in patterns, ignoring letter case differences. • subnet - Succeeds if the field value belongs to one of subnets, specified in patterns, like "1.222.94.98/32". • not_subnet - Succeeds if the field value does not belong to one of subnets. Note: subnet operator is applicable only to the client.ip match option.
values	Array	Mandatory	List of values matching the URL path string.

Response

Response Body

Parameter	Type	Description
policyId	Integer	Unique identifier of the created redirection policy.
policyName	String	Name of the redirection policy.
matches	Array	Matching configuration for the rule. See Matches for details.
redirectDestination	String	The destination URL for the redirect.
httpCode	Integer	HTTP status code for the redirect.
priority	Integer	Priority weight of the rule.
enabled	Boolean	Whether the policy is active.

Status Codes, Error Codes and Error Messages

Status Code	Error Code	Error Message
400	Request.BadRequest	Bad request.
400	InvalidCustomer.IdEmpty	Customer ID cannot be empty or invalid.
400	InvalidService.IdIncorrect	Service ID is empty or invalid.
400	InvalidService.IdPermission	Service ID cannot be found or unknown.
400	InvalidRedirection.PolicyName	Policy name is required.
400	InvalidRedirection.MatchURLIncorrect	The matches configuration cannot be empty.
400	InvalidRedirection.Operator	Operator must be one of the following values: prefix, regex, equals or suffix.
400	InvalidRedirection.MatchUrlPathPatternsIncorrect	Match patterns cannot be empty.
400	InvalidRedirection.URLEmpty	Redirect destination URL is empty.
400	InvalidRedirection.HttpCodeEmpty	HTTP status code is empty.
400	InvalidRedirection.HttpCode	HTTP status code must be 301 or 302.
400	InvalidRedirection.Priority	Policy is empty or invalid.
400	InvalidPolicy.MatchesIncorrect	Matches cannot be empty or incorrect.
400	InvalidPolicy.MatchFieldIncorrect	Match field cannot be empty and must use a valid value.
400	InvalidPolicy.MatchOperatorIncorrect	Match operator is required and must use a valid value.
400	InvalidPolicy.MatchValuesIncorrect	Match values are required and cannot be empty.
400	InvalidPolicy.MatchValueIncorrect	All match values must not be empty.

Examples

Edit Redirection V2

Request

PUT /cdn/v1.1/services/229033/redirections/262286  HTTP/1.1

{
    "policyName":"redo",
   "matches":[
        {
            "field":"req.path",
            "operator":"startswith",
            "values":["/css/","/images/abc/"]
        },
        {
            "field":"req.host",
            "operator":"iequals",
            "values":["expamle.com"]
        }

    ],
    "priority":1,
    "redirectDestination":"www.domain333.com",
    "httpCode":302,
    "enabled":true
}

Successful Response Body

{
    "policyId": 262286,
    "policyName": "redo",
    "redirectDestination": "www.domain333.com",
    "httpCode": 302,
    "matches": [
        {
            "field": "req.path",
            "operator": "startswith",
            "values": [
                "/css/",
                "/images/abc/"
            ]
        },
        {
            "field": "req.host",
            "operator": "iequals",
            "values": [
                "expamle.com"
            ]
        }
    ],
    "priority": 1,
    "enabled": true
}