api_prioritization

Property Manager name: API Prioritization Cloudlet
Behavior version: The v2025-01-13 rule format supports the api_prioritization behavior v3.0.
Rule format status: GA, stable
Access: Read/Write
Allowed in includes: Yes

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.

Option	Type	Description	Requires
`enabled`	boolean	Activates the API Prioritization feature.		{"displayType":"boolean","tag":"input","type":"checkbox"}
`is_shared_policy`	boolean	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_policy`	object	Identifies the Cloudlet policy.	`is_shared_policy` is `false`	{"displayType":"object","tag":"input","todo":true} {"if":{"attribute":"isSharedPolicy","op":"eq","value":false}}
`cloudlet_policy.id`	number	Identifies the Cloudlet.
`cloudlet_policy.name`	string	The Cloudlet's descriptive name.
`cloudlet_shared_policy`	string	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}}
`label`	string	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_code`	boolean	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_code`	object	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.cpCodeLimits`	array	Read-only. Describes the current usage limit for the CP code.
`throttled_cp_code.createdDate`	integer	Read-only. UNIX epoch timestamp reflecting when the CP code was originally created.
`throttled_cp_code.description`	string	Read-only. Additional description for the CP code.
`throttled_cp_code.id`	integer	Unique identifier for each CP code. Initially, you get this value when creating a new CP code in PAPI. You can also assign a `cpcodeId` value from the List CP codes operation.
`throttled_cp_code.name`	string	Read-only. The name of the CP code you specify as the `cpcodeName` 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.products`	array	Read-only. The set of products the CP code is assigned to. This reflects `productId` values you specify when creating a new CP code in PAPI.
`use_throttled_status_code`	boolean	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_code`	number	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_storage`	object	Specify the NetStorage domain that contains the alternate response.		{"displayType":"object","tag":"input","todo":true} {"if":{"attribute":"enabled","op":"eq","value":true}}
`net_storage.cpCode`	integer	Identifies a CP code assigned to this storage group.
`net_storage.downloadDomainName`	string	Domain name from which content can be downloaded.
`net_storage.g2oToken`	string	Signature Header Authentication key.
`net_storage.id`	integer	Unique identifier for the storage group.
`net_storage.name`	string	Name of the storage group.
`net_storagePath`	string	Specify the full NetStorage 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_ttl`	number (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}}

Updated about 1 month ago