Akamai API Security · Schema
url-protection-policy
Contains details about a URL protection policy.
API DiscoveryAPI SecurityCloud SecurityPosture ManagementRuntime ProtectionThreat Protection
Properties
| Name | Type | Description |
|---|---|---|
| apiDefinitions | array | The API endpoints to match on in incoming requests. This only applies to the `api` `matchType`. |
| bypassCondition | object | Exempts specific clients from being processed by the URL protection policy. |
| categories | array | The traffic categories to perform load shedding on when the origin traffic rate exceeds the load shedding threshold. If `intelligentLoadShedding` is set to `true`, specify one or more categories. |
| configId | integer | Uniquely identifies the security configuration. |
| configVersion | integer | The security configuration version. |
| createDate | string | __Read-only__ The timestamp when you created the URL protection policy. |
| createdBy | string | __Read-only__ The username of the person who created the URL protection policy. |
| description | string | A description of the rate policy. |
| hostnamePaths | array | The hostname and path combinations to match on. |
| intelligentLoadShedding | boolean | Enable or disable intelligent load shedding. If enabled, traffic that matches the load shedding categories is eligible for shedding if the origin rate exceeds the load shedding threshold. |
| name | string | The rate policy's unique name. |
| policyId | integer | __Read-only__ Uniquely identifies the URL protection policy. |
| protectionType | string | If matching on `hostnamePaths`, specify `SINGLE` to match on a hostname and path, or `MULTIPLE` to match on hostname and path combinations. |
| rateThreshold | integer | The allowed hits per second during any five-second interval. |
| sheddingThresholdHitsPerSec | integer | Specify the threshold value, in hits per second, after which traffic can be shed. The `sheddingThresholdHitsPerSec` value must be between 70%-90% of the `rateThreshold` value. If you enabled `intellig |
| updateDate | string | __Read-only__ The ISO 8601 timestamp when you last updated the URL protection policy. |
| updatedBy | string | __Read-only__ Username who last updated the URL protection policy. |
| used | boolean | __Read-only__ Whether you're currently using the URL protection policy. |