Get-PurgeLimit

Synopsis

Check rate and object limit statuses.

Syntax

Get-PurgeLimit [-PurgeType] <String> [[-EdgeRCFile] <String>] [[-Section] <String>] [-ProgressAction <ActionPreference>] [<CommonParameters>]

Description

The Fast Purge API uses a token bucket model for rate limiting to protect itself from inadvertent or malicious overuse. For each Akamai account, there's a rate limit shared by all object types (CP codes, cache tags, and URL/ARLs), and three separate resource limits for each object type. Each purge request uses one rate limit token from the requests bucket. Each purge object in a request takes up a token from the resource bucket.

This operation fetches information on the remaining number of requests and objects for a specific account. You can use these details to monitor the request consumption or throttle requests to prevent exceeding the limits, which results in the 429 error.

Parameters

‑EdgeRCFile

Your EdgeGrid resource file to authenticate your command. Defaults to ~/.edgerc.

‑PurgeType
Required

A single item within a purge request that identifies the content you want to purge. You can identify your content by a URL or ARL (Akamai resource locator), content provider (CP) code, or cache tag.

‑Section

The section name in your EdgeGrid resource file to retrieve authentication credentials from. Defaults to default.

Related Links