GuideReference
TrainingSupportCommunity

api_​prioritization


Enables the API Prioritization Cloudlet, which maintains continuity in user experience by serving an alternate static response when load is too high. You can configure rules using either the Cloudlets Policy Manager application or the Cloudlets API. Use this feature serve static API content, such as fallback JSON data. To serve non-API HTML content, use the visitor​_prioritization behavior.

OptionTypeDescriptionRequires
enabledboolean

Activates the API Prioritization feature.

{"displayType":"boolean","tag":"input","type":"checkbox"}
cloudlet_​policyobject

Identifies the Cloudlet policy.

{"displayType":"object","tag":"input","todo":true}
{"if":{"attribute":"enabled","op":"eq","value":true}}
cloudlet_​policy.idnumber

Identifies the Cloudlet.

cloudlet_​policy.namestring

The Cloudlet's descriptive name.

labelstring

A label to distinguish this API Prioritization policy from any others in the same property.

{"displayType":"string","tag":"input","type":"text"}
{"if":{"attribute":"enabled","op":"eq","value":true}}
use_​throttled_​cp_​codeboolean

Specifies whether to apply an alternative CP code for requests served the alternate response.

{"displayType":"boolean","tag":"input","type":"checkbox"}
{"if":{"attribute":"enabled","op":"eq","value":true}}
throttled_​cp_​codeobject

Specifies the CP code as an object.

use_​throttled_​cp_​code is true
{"displayType":"object","tag":"input","todo":true}
{"if":{"op":"and","params":[{"attribute":"enabled","op":"eq","value":true},{"attribute":"useThrottledCpCode","op":"eq","value":true}]}}
throttled_​cp_​code.descriptionstring

Additional description for the CP code.

throttled_​cp_​code.idinteger

Unique identifier for each CP code.

throttled_​cp_​code.namestring

The name of the CP code.

throttled_​cp_​code.productsarray

The set of products the CP code is assigned to.

use_​throttled_​status_​codeboolean

Allows you to assign a specific HTTP response code to a throttled request.

{"displayType":"boolean","tag":"input","type":"checkbox"}
{"if":{"attribute":"enabled","op":"eq","value":true}}
throttled_​status_​codenumber

Specifies the HTTP response code for requests that receive the alternate response.

use_​throttled_​status_​code is true
{"displayType":"number","tag":"input","type":"number"}
{"if":{"op":"and","params":[{"attribute":"enabled","op":"eq","value":true},{"attribute":"useThrottledStatusCode","op":"eq","value":true}]}}
net_​storageobject

Specify the Net​Storage domain that contains the alternate response.

{"displayType":"object","tag":"input","todo":true}
{"if":{"attribute":"enabled","op":"eq","value":true}}
net_​storage.cp​Code​Listarray

A set of CP codes that apply to this storage group.

net_​storage.download​Domain​Namestring

Domain name from which content can be downloaded.

net_​storage.idnumber

Unique identifier for the storage group.

net_​storage.namestring

Name of the storage group.

net_​storage.upload​Domain​Namestring

Domain name used to upload content.

net_​storage​Pathstring

Specify the full Net​Storage path for the alternate response, including trailing file name.

{"displayType":"string","tag":"input","type":"text"}
{"if":{"attribute":"enabled","op":"eq","value":true}}
alternate_​response_​cache_​ttlnumber (5-30)

Specifies the alternate response's time to live in the cache, 5 minutes by default.

{"displayType":"number","max":[30],"min":[5],"tag":"input","type":"range"}
{"if":{"attribute":"enabled","op":"eq","value":true}}