API
TrainingSupportCommunity

apiPrioritization

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"}
is​Shared​Policyboolean 
Whether you want to apply the Cloudlet shared policy to an unlimited number of properties within your account. Learn more about shared policies and how to create them in Cloudlets Policy Manager.
{"displayType":"boolean","tag":"input","type":"checkbox"}
{"if":{"attribute":"enabled","op":"eq","value":true}}
cloudlet​Policyobject 
Identifies the Cloudlet policy.
is​Shared​Policy is false
{"displayType":"object","tag":"input","todo":true}
{"if":{"attribute":"isSharedPolicy","op":"eq","value":false}}
cloudlet​Policy.idnumber
Identifies the Cloudlet.
cloudlet​Policy.namestring
The Cloudlet's descriptive name.
cloudlet​Shared​Policystring 
Identifies the Cloudlet shared policy to use with this behavior. Use the Cloudlets API to list available shared policies.
is​Shared​Policy is true
{"displayType":"string","tag":"input","type":"text"}
{"if":{"attribute":"isSharedPolicy","op":"eq","value":true}}
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. You only need to provide the initial id, stripping any cpc_ prefix to pass the integer to the rule tree. Additional CP code details may reflect back in subsequent read-only data.
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.cp​Code​Limitsarray
Read-only. Describes the current usage limit for the CP code.
throttled​Cp​Code.created​Dateinteger
Read-only. UNIX epoch timestamp reflecting when the CP code was originally created.
throttled​Cp​Code.descriptionstring
Read-only. Additional description for the CP code.
throttled​Cp​Code.idinteger
Unique identifier for each CP code. Initially, you get this value when creating a new CP code in PAPI. You can also assign a cpcode​Id value from the List CP codes operation.
throttled​Cp​Code.namestring
Read-only. The name of the CP code you specify as the cpcode​Name when creating a new CP code in PAPI. You can modify this value with the PUT operation in the CP codes and Reporting Groups API.
throttled​Cp​Code.productsarray
Read-only. The set of products the CP code is assigned to. This reflects product​Id values you specify when creating a new CP code in PAPI.
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​Codeinteger
Identifies a CP code assigned to this storage group.
net​Storage.download​Domain​Namestring
Domain name from which content can be downloaded.
net​Storage.g2o​Tokenstring
Signature Header Authentication key.
net​Storage.idinteger
Unique identifier for the storage group.
net​Storage.namestring
Name of the storage group.
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}}