Akamai cp code api. Work with your account representative.

Akamai cp code api In the CP Code Name field, type a new name. Determine which Akamai network you want to use. FastPurge will typically invalidate (recommended), or delete cached content in under five seconds. Rule format status : Beta, possible breaking changes Access : Read/Write Allowed in includes : Not available for latest rule format Match the assigned content provider code Oct 21, 2024 · Version: v2024-10-21 Includes use: Yes Behavior name: Content Provider Code Content Provider Codes (CP codes) allow you to distinguish various reporting and billing traffic segments, and you need them to access properties. This operation also lists the access control group the CP code belongs to. You can use these as is in your configurations or make adjustments based on the criterion's available options Content Provider (CP) codes. Click Submit Purge. Find the Hostname (s) from the Akamai Property Manager. Could you please share the details around APIs that gives the list of CP codes which belong to a contract and subsequently details of another api which helps to fetch usage statistics based on the cp codes. The OTA Updates API provides you with a list of completed downloads by vehicle, limited only to those downloads associated with a content provider code. An API configuration registered with Akamai . Aug 6, 2020 · Watch a short video on how to edit CP codes here. cp_ code custom_ behavior datastream delivery_ receipt deny_ access deny_ direct_ failover_ access device_ characteristic_ cache_ id device_ characteristic_ header dns_ async_ refresh dns_ prefresh downgrade_ protocol download_ complete_ marker download_ notification downstream_ cache dynamic_ throughtput_ optimization 📘 If you need to modify the contract or product tied to a CP code, contact your account representative. In most cases, you should invalidate rather than delete content. Jan 9, 2024 · Version: v2024-01-09 Includes use: Yes Behavior name: Content Provider Code Content Provider Codes (CP codes) allow you to distinguish various reporting and billing traffic segments, and you need them to access properties. View this and other Technical limits with NetStorage . All CP codes have ties to one or more services, which are tracked and reported under that CP code. Search JUMP TO API CP Codes and Reporting Groups API API summary Get started Concepts Feb 12, 2024 · Version: v2024-02-12 Includes use: Yes Behavior name: Content Provider Code Content Provider Codes (CP codes) allow you to distinguish various reporting and billing traffic segments, and you need them to access properties. To run this operation, your user account needs the CPCode Rep Group role. You can use these approaches to generate CP codes: Use this API to create a CP code Use the NetStorage application in Control Center to create CP codes when adding a new upload directory ( ☰ > ORIGIN SERVICES > NetStorage). You may also generate additional CP codes, typically to implement more detail API summary See the API's various operations for details on their request parameters and response data. The process is common for all {OPEN} APIs and is very well documented here: Authorize Your Client . The CP Codes and Reporting Groups API offers a programmatic interface to manage CP codes and reporting groups. To view or update certain CP code data, such as name, time zone, and purgeability, use the CP Codes and Reporting Groups API . You receive an initial CP code when purchasing Akamai, and you can run the Create a new CP code operation to generate more. On the Reporting groups tab, click the group name. You can purge content by either the URL, CP code, or cache tag. You can also provide multiple entries as comma-separated strings. Get the IDs of the Content Provider (CP) reporting groups that you have access to. CP code number, contract or service cannot be changed through the steps outlined here. Get a list of all CP codes that are assigned to a storage group. Gets all CP codes or returns a specific CP code by its ID available within your account and contract. When you purge your cached content by URL, ARL, CP code or cache tag, you select either Invalidate or Delete. As a small bit of follow up, a CP Code is Akamai's unique identifier tying a particular domain or service to your contract for billing purposes. Deletes content on the selected CP code for the selected network. Start sending API requests with the Get a CP code public request from Akamai APIs on the Postman API Network. This is the basic unit within a NetStorage instance. Apr 18, 2025 · Functions to manage the Akamai CP Codes & Reporting Groups API. You can write contractid and groupId data only on the initial POST operation. Use the NetStorage Configuration API to create a CP code. 📘 You can't edit the reporting group ID or associated contract. Property Manager name : Content Provider Code Criteria version : The latest rule format supports the matchCpCode criteria v1. 📘 If you need to modify the contract or product tied to a CP code, contact your account representative. A unique alphanumeric name. You receive an initial CP code when purchasing Akamai, and you can run the Cr The rate of aggregated log lines (forward requests containing HTTP event data at the edge sent in an HTTPS POST request from Akamai edge servers to your origin) per second, for the selected date range, traffic segments (CP codes), and traffic type. You assign CP codes to a property within its rule tree. Data sources API endpoints API request constraints Attack groups Attack payload logging Bypass network lists Configuration Configuration version Contracts groups Custom deny Custom rule actions Custom rules Eval group Eval penalty box Eval rules Evasive path match Failover hostnames Hostname coverage Hostname coverage match targets Hostname Data sources API endpoints API request constraints Attack groups Attack payload logging Bypass network lists Configuration Configuration version Contracts groups Custom deny Custom rule actions Custom rules Eval group Eval penalty box Eval rules Evasive path match Failover hostnames Hostname coverage Hostname coverage match targets Hostname Data sources API endpoints API request constraints Attack groups Attack payload logging Bypass network lists Configuration Configuration version Contracts groups Custom deny Custom rule actions Custom rules Eval group Eval penalty box Eval rules Evasive path match Failover hostnames Hostname coverage Hostname coverage match targets Hostname Get a list of CP codes that aren't assigned to a storage group. You'll use it to create an Ion delivery configuration. A customer and a single contract may have multiple CP codes. Account An account key that Akamai customers use to access all their services. Deletion retrieves the object regardless, which can dramatically increase the load on your origin server and would prevent Akamai from serving the old content if your origin When you onboard your site, application, or any other asset in Property Manager, you can create a CP code directly from the CP Code behavior. The details include the CP code type, name, time zone, as well as the account, contracts, and products it's assigned to. In the upper right corner, click Edit . This extension adds Akamai Cache Purge task to Azure DevOps pipelines to purge content cache at the Akamai Edge using Fast Purge API. These limits are enforced regardless of whether you use a configuration application, such as Property Manager, or a corresponding API, such as P This section details the API's response object format and range of HTTP error responses. Groups let you narrow down your content to groups of CP codes. Data sources API endpoints API request constraints Attack groups Attack payload logging Bypass network lists Configuration Configuration version Contracts groups Custom deny Custom rule actions Custom rules Eval group Eval penalty box Eval rules Evasive path match Failover hostnames Hostname coverage Hostname coverage match targets Hostname Data sources API endpoints API request constraints Attack groups Attack payload logging Bypass network lists Configuration Configuration version Contracts groups Custom deny Custom rule actions Custom rules Eval group Eval penalty box Eval rules Evasive path match Failover hostnames Hostname coverage Hostname coverage match targets Hostname URL's CP code. Make sure you provide the product IDs in the format returned by the Get-Product operation. Endpoint. Fast purge Fast purge processes updates across the Akamai edge network in just seconds. For example, 4 API clients in Identity and Access Management Property Application Security API Definitions Bot Manager Client Lists Network Lists New-NetstorageCPCode cp_ code custom_ behavior datastream delivery_ receipt deny_ access deny_ direct_ failover_ access device_ characteristic_ cache_ id device_ characteristic_ header dns_ async_ refresh dns_ prefresh downgrade_ protocol download_ complete_ marker download_ notification downstream_ cache dynamic_ throughtput_ optimization Cloudlets Set up Cloudlets policies Data Sources API prioritization match rule Application load balancer Audience segmentation match rule Edge redirector match rule May 18, 2018 · I had a simple use case/workflow where I needed to purge Akamai cache after content deployment. Feb 21, 2024 · A content provider code, or CP code, is used to identify a subset of traffic and content for billing, reporting, and monitoring. For CP code-based operations, an array of the CP codes you want to purge. Contribute to apiheat/akamai-cli-cpcodes development by creating an account on GitHub. After running the GET a CP code operation, use the response to build a request body. During initial provisioning of your Get the IDs of the Content Provider (CP) reporting groups that you have access to along with their names. While administrators may have access to more than one A Purge API request can contain only URLs / ARLs, only CP Codes, or only Cache Tags in the request body. All traffic served through the network must be assigned to a CP code. These options correspond to the networks configured in the Akamai Property Manager. If an error occurs, this API responds with JSON objects that provide information you can use to debug the problem. Generate CP codes for your storage groups. You pick this akamai_iam_api_client📘 To use this resource, your API client must have the option to create credentials for another API client enabled. Two most common changes to CP codes are name change and enabling /disabling purge by CP code option. Storage Group . Feb 12, 2024 · Version: v2024-02-12 Includes use: Yes Behavior name: Content Provider Code Content Provider Codes (CP codes) allow you to distinguish various reporting and billing traffic segments, and you need them to access properties. For examples you can copy and paste, check out the Recipes. Apr 5, 2024 · This article explains how to check which CP Code (s) an API Client with purging API access is allowed to submit Modify the list of the CP codes your reporting group collects data for. You pick this Feb 18, 2025 · Version: v2025-02-18 Includes use: Yes Behavior name: Content Provider Code Content Provider Codes (CP codes) allow you to distinguish various reporting and billing traffic segments, and you need them to access properties. A CP code is comprised of two parts: An integer value. You can also automate your fast purge requests with the Fast purge API . getCpCodes function with examples, input properties, output properties, and supporting types. Traditionally, we have a bunch of CP codes (35 of em) which we used to purge from Luna CCU post deployment. x and will be using Akamai purge rest api. Each storage group comprises: A unique name Load Balancer Configuration Separate origin Data Sources API prioritization match rule Application load balancer Audience segmentation match rule Edge redirector match rule Version: v2025-04-29Includes use: YesBehavior name: Content Provider CodeContent Provider Codes (CP codes) allow you to distinguish various reporting and billing traffic segments, and you need them to access properties. API client akamai_iam_api_client 🚧 Beta This is a beta version of this resource. This behavior applies any valid CP code, either as required as a default at the top of the rule tree, or subsequently to akamai_api CCU cpcode # CP Code CCU actions akamai_api CCU help [COMMAND] # Describe subcommands or one specific subcommand akamai_api CCU arl # ARL CCU actions Data sources API endpoints API request constraints Attack groups Attack payload logging Bypass network lists Configuration Configuration version Contracts groups Custom deny Custom rule actions Custom rules Eval group Eval penalty box Eval rules Evasive path match Failover hostnames Hostname coverage Hostname coverage match targets Hostname This lists the various conceptual objects the API makes available. The CP code tags your content so edge servers can identify what content belongs to which contracts and services. This also automatically deactivates the API client's credential. HTTP method. 📘 If you don't see the option to create CP codes in the CP Code behavior in Property Manager, and you need this ability, reach out to your account team. Based on CP codes, you collect information for billing, reporting and monitoring purposes. Click Submit . Purges content from the Akamai cache on either the staging or production network. Use the API. This section details the API's response object format and range of HTTP error responses. Apr 10, 2025 · Functions to manage the Akamai CP Codes & Reporting Groups API. Akamai 's Fast Purge supports two different methods. The extension can either purge content by URL or purge content by CP Code approach with invalidate or delete request method There are a few ways you can get a CP code: Create a CP code when adding a new storage group. Content Provider (CP) Codes identify a particular subset of traffic and content delivered over the Akamai network. Lists detailed information about CP codes available within your account and contract. See the API's various operations for details on their request parameters and response data. Logging into Luna and manually selecting each CP code was painful and caused lot of human errors. Apr 5, 2024 · This article explains how to check which CP Code (s) an API Client with purging API access is allowed to submit Use Akamai APIs to automate your workflows. Get to know the conceptual objects that are common for both CP codes and reporting groups. CP codes inc Content Provider codes (CP codes) identify your traffic on the Akamai network for reporting, billing, and monitoring purposes. Pass an empty data block to get your own API client. When you purchase an Akamai product, you create a CP code as you onboard associated properties. You receive an initial CP code when purchasing Akamai, and you can run the Cr Jan 5, 2023 · Version: v2023-01-05 Includes use: Yes Behavior name: Content Provider Code Content Provider Codes (CP codes) allow you to distinguish various reporting and billing traffic segments, and you need them to access properties. Application Security Configure AppSec Match targets Rate policy Data sources AAP selected hostnames API endpoints API request constraints Attack groups Attack payload Aug 6, 2020 · Watch a short video on how to edit CP codes here. To view or update certain CP code data, such as name, time zone, and purgeability, use the CP Codes and Reporting Groups API. To retrieve a specific CP code, you need to specify its ID. Decide whether to enable purging content with Fast Purge based on a CP code it identifies. To add this role, use the Identity and Access Management application . Akamai CLI for Purge allows you to purge cached content from the Edge using FastPurge (CCUv3). You can only modify a CP code's name, time zone, and purgeable member. 📘 To use this resource, your API client must have the option to create credentials for another API client enabled. ## Default criterionThese samples reflect the criterion's default settings. In the CP codes list, select the CP codes to add to your group or desele Use the Fast Purge API to purge edge content, including URLs, ARLs (Akamai resource locators), or any content grouped under a content provider (CP) code or cache tag. Additionally, you can specify the method to use when purging content, either invalidate or delete. Immediately provide corrected content despite your default cache settings or purge content, URLs, or Akamai Resource Locators. The details include the reporting group name and the access control group that it belongs to. Before you exchange data between the CP Codes and Reporting Groups API and PAPI, make sure to remove the ID prefixes . We could not find the Collection you are looking for. Depending on your use case and the type of content you want to refresh, you may use different purging mechanisms. Enhanced purge (ECCU) only invalidates content. This operation gets details about a CP code. This operation uses the Property API, and thus its output will differ slightly from the Get-CPCode operation. Content provider (CP) codes let you segment your delivered content for tracking and reporting purposes. You can import the resource only if it has assigned Content Provider Codes (CP codes) allow you to distinguish various reporting and billing traffic segments, and you need them to access properties. This is a 5-7 digit value that Akamai generates. You receive an initial CP code when purchasing Akamai, and you can run the Cr Jan 9, 2019 · Akamai is one of the world’s leading Content Delivery Network (CDN) providers. This operation lists CP codes available within your contract and group pairing. CpCode resource with examples, input properties, output properties, lookup functions, and supporting types. There's a limit on the number of storage groups you can maintain. uses to track the use of its CDN services. Apr 27, 2022 · we support multi-domain web sites in the project and trying to create a automated process to clear the cache from akamai when a page published/replicated. This means all current and future CP codes on the current contract, not all CP codes on the account. To delete the resource, you can do one of these: Run terraform destroy. Akamai CP Codes CLI. Invalidation keeps each object in cache until the version on your origin server is newer. Select a method — either Invalidate or Delete. The extension can either purge content by URL or purge content by CP Code approach with invalidate or delete request method Modifies a specific CP code. Deactivate an active CP code (required). Gets a list of CP codes that aren't assigned to a storage group. Product support Fast Purge works with a number of Akamai products and services: Ion Adaptive Media Delivery Dynamic Delivery Dynamic Site Accelerator Learn more Directory or Get detailed information about a specific CP code. Purge is a tool for refreshing specific cached objects or removing all stale content across the Akamai edge network. Contribute to akamai/akamai-apis development by creating an account on GitHub. Start sending API requests with the List CP codes public request from Akamai APIs on the Postman API Network. If you have thousands o Documentation for the akamai. You can import the resource only if it has assigned credentials. Operation Method Endpoint CP Codes List CP codes GET /cpcodes Get a water-mark limit GET /cpcodes/ contracts/ {contractId}/ watermark-limits Get a CP code GET /cpcodes/ {cpcodeId} Update a CP code PUT /cpcode Gets all CP codes available under a given contract and group. You may also generate additional CP codes, typically to implement more de Content Provider codes (CP codes) identify your traffic on the Akamai network for reporting, billing, and monitoring purposes. This behavior applies any valid CP code, either as required as a default at the top of the rule tree, or subsequently to A content provider (CP) code is what Akamai Technologies, Inc. what are the steps we do on the AEM side. You receive an initial CP code when purchasing Akamai, and you can run the Cr Documentation for the akamai. The purge requests are propagated through the Akamai edge network, using either the invalidate or delete purge Documentation for the akamai. Version: v2023-10-30 Includes use: Yes Behavior name: Content Provider Code Content Provider Codes (CP codes) allow you to distinguish various reporting and billing traffic segments, and you need them to access properties. Add API client to Sitecore You must configure Sitecore to associate the API client with your Sitecore site. You receive an initial CP code when purchasing Akamai, and you can run the Cr CP code (required). Feb 11, 2019 · Akamai - Akamai - CPCode Fast Purge: Allows to purge CP codes using the Content Control Utility (CCU) v3 REST API. A content provider is an Akamai customer that serves traffic on the Akamai network. A message appears at the top of the page, letting you know your request was accepted and will be completed within a few seconds. You can refresh your content on edge servers based on a few categories. On the CP codes tab, click the CP code name. CP code (required). 5. The rate limit applies to all API clients in your Akamai account as a whole. This operations also lists the contracts and CP codes assigned to the reporting group. This behavior applies any valid CP code, either as required as a default at the top of A 500 response indicates the API can't provide the requested resource, and it may be corrupted. You receive an initial CP code when purchasing Akamai, and you can run the Cr Obtains CP codes based on the provided -Type. You receive an initial CP code when purchasing Akamai, and you can run the Cr Depending on your use case and the type of content you want to refresh, you may use different purging mechanisms. If you have thousands o May 30, 2023 · Version: v2023-05-30 Includes use: Yes Behavior name: Content Provider Code Content Provider Codes (CP codes) allow you to distinguish various reporting and billing traffic segments, and you need them to access properties. To configure this API for the first time: Before you can use this API, you need to Create authentication credentials . Through the Akamai Intelligent Platform many products are offered to aid performance, availability, security, and Get detailed information about a specific reporting group. A completed download is defined by the download complete marker behavior and its match criteria while configuring the OTA Updates property. To list all CP codes in your account at once, without having to filter the request by contracts and groups, use the CP Codes and Reporting Groups API . You receive an initial CP code when purchasing Akamai, and you can run the Cr Delete the automatic purge routine for a specific CP code. To enable this API, choose the API service named CPcode and Reporting group (CPRG) , and set the access level to READ WRITE . Metrics KPI metrics Origin. Note that deploying packages with dependencies will deploy all the dependencies to Azure Automation. API IoT OTA Updates API API summary OpenAPI schema Get started Rate limits Errors 400 401 403 404 405 406 500 CP codes CP codes List content provider codes get Lists detailed information about reporting groups available for your account and contract. Search JUMP TO API CP Codes and Reporting Groups API API summary Get started Concepts Enum Specifies whether to retrieve AKAMAI or THIRD_PARTY CP codes. If you've a need to change CP code service or contract please get in touch with your Akamai account team or create a Business Support Request. Version: v2025-02-18Includes use: YesCriterion name: Content Provider CodeMatch the assigned content provider code. Learn More. For more specific details, see About CP codes and About reporting groups . Each object (URL/ARL, CP Code, or Cache Tag) in an API request consumes 1 token of its respective type from the table above. Create and update an API client. Work with your account representative. An individual request can't contain multiple object types. With a toggle switc CP code (required). You can skip it if you already have your API credentials and read/write access on Content Control Utility v2/v3. This section covers the conceptual objects of the CP Codes and Reporting Groups API. A CP code tags each content segment so that edge servers can map it to your contract and product. we have AMS environment with AEM 6. You can only create up to a certain number of CP codes and reporting groups within your account. Feb 21, 2024 · Create a new Content Provider Code (CP Code) About Content Provider Codes (CP Codes) and how to generate a new one in Control Center Use this Property Manager CLI to automate Akamai property changes and deployments across many environments. A CP code is a unique identifier assigned to each customer, used primarily for billing, reporting, and access control. Optionally, pass a client ID to get details of another API client. Content Provider Codes (CP codes) allow you to distinguish various reporting and billing traffic segments, and you need them to access properties. Jul 7, 2025 · Behavior name: Content Provider Code Content Provider Codes (CP codes) allow you to distinguish various reporting and billing traffic segments, and you need them to access properties. The code examples in this API reference don't contain the required authentication code syntax you need to make API calls. Your account team will initially get you at least one of these codes for this workflow. Akamai API docs include dynamic code samples and tutorials in various programming languages. May 31, 2018 · Similarly with Akamai's EdgeGrid: Last pre-requisite to start hacking Purge API is API credentials. These limits are enforced regardless of whether you use a configuration application, such as Property Manager, or a corresponding API, such as P To view or update certain CP code data, such as name, time zone, and purgeability, use the CP Codes and Reporting Groups API. You need a CP code to create a stream. It also details contracts and products associated with each CP code, and contracts and CP codes associated with each reporting group. Groups (optional). Hyper Solutions SDK for Python - With support for Akamai Bot Manager, Incapsula, Datadome and Kasada. Find the CP Code (s) from the Akamai Property Manager. 1. . I was trying to follo Data sources API endpoints API request constraints Attack groups Attack payload logging Bypass network lists Configuration Configuration version Contracts groups Custom deny Custom rule actions Custom rules Eval group Eval penalty box Eval rules Evasive path match Failover hostnames Hostname coverage Hostname coverage match targets Hostname URL's CP code. Select the Akamai network on which you want to refresh content — either Production or Staging. Use of this version is as is and as available while still in testing and development. Sep 6, 2018 · The API's documentation will give you the links to understanding the API and how to configure the appropriate credentials. Content provider codes identify a particular subset of traffic and content delivered over the Akamai network. You can deploy this package directly to Azure Automation. It doesn't remove it from cache. The wizard used to create a new storage group offers options you can use to define a new CP code, while configuring an upload directory for the group. Copy and Paste the following command to install this package using PowerShellGet More Info. You can also run this API with a Postman collection. You receive an initial CP code when purchasing Akamai, and you can run the Creat Data sources API endpoints API request constraints Attack groups Attack payload logging Bypass network lists Configuration Configuration version Contracts groups Custom deny Custom rule actions Custom rules Eval group Eval penalty box Eval penalty box conditions Eval rules Evasive path match Failover hostnames Hostname coverage Hostname If you interact with Property Manager API (PAPI), note that PAPI response data features various ID values with three-letter prefixes to help distinguish their function. Note: CP codes need to be associated with one or more products. Here's a recipe for updating a CP code with API: Creates a new CP code. CP codes and reporting groups have high water-mark limits. A support ID is also included. qrxt tmwozs kgyn enbtmb laream btcvjsa qfnxod vtao pattgq pbnsp lbhcvs gxoyz iowycijk unw oqr