Get a URL protection policy

Returns the specified URL protection policy. Products: All.

Path Params
int64
required

A unique identifier for each configuration.

integer
required

A unique identifier for each version of a configuration.

int64
required

A unique identifier for each URL protection policy.

Query Params
string

For customers who manage more than one account, this runs the operation from another account. The Identity and Access Management API provides a list of available account switch keys.

Responses

Response body
object
apiDefinitions
array of objects

The API endpoints to match on in incoming requests. This only applies to the api matchType.

apiDefinitions
object
int64
required

Uniquely identifies each API endpoint.

boolean

When true, match on any resource explicitly added to your API definition without including a resourceId. When false, you'll need to pass a resourceId.

resourceIds
array of int64s

The unique identifiers of the endpoint's resources.

resourceIds
boolean

When true, match on any resource you have not explicitly added to your API definition without including a resourceId. When false, you'll need to pass a resourceId.

bypassCondition
object

Exempts specific clients from being processed by the URL protection policy.

atomicConditions
array
length ≥ 1

Specify one or more types of conditions to match on. You can match on client lists, request headers, or both.

atomicConditions
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.

categories
int64

Uniquely identifies the security configuration.

integer

The security configuration version.

date-time

Read-only The timestamp when you created the URL protection policy.

string

Read-only The username of the person who created the URL protection policy.

string

A description of the rate policy.

hostnamePaths
array of objects
length ≥ 1

The hostname and path combinations to match on.

hostnamePaths
object
string
required

The hostnames you choose to match on.

paths
array of strings
required

The list of paths to match on.

paths*
boolean
required

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.

string
required

The rate policy's unique name.

int64

Read-only Uniquely identifies the URL protection policy.

string

If matching on hostnamePaths, specify SINGLE to match on a hostname and path, or MULTIPLE to match on hostname and path combinations.

SINGLE MULTIPLE

integer
required

The allowed hits per second during any five-second interval.

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 intelligentLoadShedding, this value is required.

date-time

Read-only The ISO 8601 timestamp when you last updated the URL protection policy.

string

Read-only Username who last updated the URL protection policy.

boolean

Read-only Whether you're currently using the URL protection policy.

Language
Authentication
URL