# Adaptive Acceleration Documentation > Adaptive Acceleration syncs with ​Akamai​ real user monitoring to gather navigation and resource timing data and stores that data in a policy that's associated with your hostname. As requests for your hostname continue, policy data is gathered and reviewed to identify key resources. ## Guides - [Welcome to Adaptive Acceleration](https://techdocs.akamai.com/adaptive-acceleration/docs/welcome-adaptive-acceleration.md) - [About reports](https://techdocs.akamai.com/adaptive-acceleration/docs/manage-the-automatic-push-and-preconnect-policy.md) - [View and troubleshoot a report](https://techdocs.akamai.com/adaptive-acceleration/docs/view-and-troubleshoot-a-policy.md) - [Reset the report](https://techdocs.akamai.com/adaptive-acceleration/docs/reset-the-policy.md) - [Real user monitoring reports](https://techdocs.akamai.com/adaptive-acceleration/docs/troubleshoot.md) ## API Reference - [Adaptive Acceleration API](https://techdocs.akamai.com/adaptive-acceleration/reference/api.md) - [API summary](https://techdocs.akamai.com/adaptive-acceleration/reference/api-summary.md) - [Get started](https://techdocs.akamai.com/adaptive-acceleration/reference/get-started.md) - [Rate limiting](https://techdocs.akamai.com/adaptive-acceleration/reference/rate-limiting.md) - [Errors](https://techdocs.akamai.com/adaptive-acceleration/reference/errors.md) - [401](https://techdocs.akamai.com/adaptive-acceleration/reference/401.md) - [403](https://techdocs.akamai.com/adaptive-acceleration/reference/403.md) - [404](https://techdocs.akamai.com/adaptive-acceleration/reference/404.md) - [405](https://techdocs.akamai.com/adaptive-acceleration/reference/405.md) - [406](https://techdocs.akamai.com/adaptive-acceleration/reference/406.md) - [503](https://techdocs.akamai.com/adaptive-acceleration/reference/503.md) - [Get a property report](https://techdocs.akamai.com/adaptive-acceleration/reference/get-property.md): Gets the current Adaptive Acceleration report for a specific Ion property. - [Reset a property report](https://techdocs.akamai.com/adaptive-acceleration/reference/post-property-reset.md): Resets the report Adaptive Acceleration uses to define a server push and preconnect assets. Adaptive Acceleration reviews current real-user monitoring data to reestablish this report. ## Recipes - [Get a property report](https://techdocs.akamai.com/adaptive-acceleration/recipes/get-a-property-report.md) - [Reset a property report](https://techdocs.akamai.com/adaptive-acceleration/recipes/reset-a-property-report-1.md) ## Changelog - [Jun 5, 2023 — New Adaptive Acceleration user interface](https://techdocs.akamai.com/adaptive-acceleration/changelog/jun-5-2023-new-adaptive-acceleration-user-interface.md) - [Feb 1, 2022 — New Adaptive Acceleration documentation experience](https://techdocs.akamai.com/adaptive-acceleration/changelog/feb-1-2022-new-adaptive-acceleration-documentation-experience.md) - [Jun 4, 2021 — User interface updates](https://techdocs.akamai.com/adaptive-acceleration/changelog/jun-4-2021-user-interface-udpates.md) - [Mar 12, 2021 — Beacons from bots used in policies now filtered](https://techdocs.akamai.com/adaptive-acceleration/changelog/mar-12-2021-beacons-from-bots-now-filtered.md) - [Apr 1, 2020 — Resource Optimizer new features and bug fix](https://techdocs.akamai.com/adaptive-acceleration/changelog/apr-1-2020-new-features-and-bug-fix.md) # Adaptive Media Delivery Documentation > Delivers streaming video and a quality viewing experience anywhere by adapting real-time to available bandwidth. To meet consumer expectations in a hyperconnected world, content providers need a high-performance streaming media delivery solution like Akamai’s Adaptive Media Delivery. Optimized for Adaptive Bitrate (ABR) streaming, it provides a high-quality viewing experience across the broad variety of network types, fixed or mobile, at varying connection speeds. Because it’s built on the Akamai Intelligent Platform, Adaptive Media Delivery provides superior scalability, reliability, and availability. ## Guides - [Welcome to Adaptive Media Delivery](https://techdocs.akamai.com/adaptive-media-delivery/docs/welcome-adaptive-media-deliv.md) - [Delivery concepts and terms](https://techdocs.akamai.com/adaptive-media-delivery/docs/key-concepts-and-terms.md) - [Review supported media formats](https://techdocs.akamai.com/adaptive-media-delivery/docs/supported-media-formats.md) - [Get your unique information](https://techdocs.akamai.com/adaptive-media-delivery/docs/get-environ-info.md) - [Understand the request flow](https://techdocs.akamai.com/adaptive-media-delivery/docs/understand-the-request-flow.md) - [Prepare your environment](https://techdocs.akamai.com/adaptive-media-delivery/docs/prepare-your-environment.md) - [Create a new AMD property](https://techdocs.akamai.com/adaptive-media-delivery/docs/create-new-prop.md) - [Define property hostnames](https://techdocs.akamai.com/adaptive-media-delivery/docs/define-prop-hn.md) - [Define property variables (optional)](https://techdocs.akamai.com/adaptive-media-delivery/docs/define-prop-vars-optal.md) - [Define property configuration settings](https://techdocs.akamai.com/adaptive-media-delivery/docs/define-prop-config-settings.md) - [Default optimizations](https://techdocs.akamai.com/adaptive-media-delivery/docs/best-practices-use-case-based-prov.md) - [Origin Server](https://techdocs.akamai.com/adaptive-media-delivery/docs/origin-server-amd.md) - [Content Provider Code](https://techdocs.akamai.com/adaptive-media-delivery/docs/content-provider-code-amd.md) - [Segmented Media Delivery Mode](https://techdocs.akamai.com/adaptive-media-delivery/docs/segmented-media-deliv-mode-amd.md) - [Origin Characteristics](https://techdocs.akamai.com/adaptive-media-delivery/docs/origin-charac-amd.md) - [Content Characteristics](https://techdocs.akamai.com/adaptive-media-delivery/docs/content-charac-amd.md) - [Client Characteristics](https://techdocs.akamai.com/adaptive-media-delivery/docs/client-charac-amd.md) - [Cache Key Query Parameters](https://techdocs.akamai.com/adaptive-media-delivery/docs/cache-key-query-param-amd.md) - [Tiered Distribution](https://techdocs.akamai.com/adaptive-media-delivery/docs/tiered-dist-amd.md) - [Recommended behaviors in the Default Rule](https://techdocs.akamai.com/adaptive-media-delivery/docs/rcmd-behs-default-rule.md) - [Optional behaviors in the Default Rule](https://techdocs.akamai.com/adaptive-media-delivery/docs/optal-behs-default-rule.md) - [The Default CORS Policy Rule](https://techdocs.akamai.com/adaptive-media-delivery/docs/default-cors-policy-rule.md) - [Add optional rules](https://techdocs.akamai.com/adaptive-media-delivery/docs/add-optal-rules.md) - [Finalize your AMD property](https://techdocs.akamai.com/adaptive-media-delivery/docs/finalize-amd-prop.md) - [Test your AMD property](https://techdocs.akamai.com/adaptive-media-delivery/docs/test-amd-prop.md) - [Go live with AMD](https://techdocs.akamai.com/adaptive-media-delivery/docs/go-live.md) - [AMD origin failover](https://techdocs.akamai.com/adaptive-media-delivery/docs/add-amd-origin-failover.md) - [Set up your primary origin](https://techdocs.akamai.com/adaptive-media-delivery/docs/setup-primary-origin.md) - [Configure the recovery methods](https://techdocs.akamai.com/adaptive-media-delivery/docs/configure-the-recovery-methods.md) - [Set up your recovery policy](https://techdocs.akamai.com/adaptive-media-delivery/docs/set-up-your-recovery-policy.md) - [Known issues with AMD origin failover](https://techdocs.akamai.com/adaptive-media-delivery/docs/known-issues-with-amd-origin-failover.md) - [Auth Token 2.0 Verification](https://techdocs.akamai.com/adaptive-media-delivery/docs/auth-token-20-verification-amd.md) - [Bit Rate Limiting](https://techdocs.akamai.com/adaptive-media-delivery/docs/add-bit-rate-limiting.md) - [Breadcrumbs](https://techdocs.akamai.com/adaptive-media-delivery/docs/add-breadcrumbs.md) - [Client Hints](https://techdocs.akamai.com/adaptive-media-delivery/docs/client-hints.md) - [Cloud Access Manager](https://techdocs.akamai.com/adaptive-media-delivery/docs/add-cloud-access-manager.md) - [Cloud Wrapper](https://techdocs.akamai.com/adaptive-media-delivery/docs/cloud-wrapper.md) - [Common Media Client Data](https://techdocs.akamai.com/adaptive-media-delivery/docs/common-media-client-data-amd.md) - [Content Targeting Protection](https://techdocs.akamai.com/adaptive-media-delivery/docs/add-content-tgting-prot.md) - [The Content-Type header](https://techdocs.akamai.com/adaptive-media-delivery/docs/manage-content-type.md) - [Early Data (0-RTT)](https://techdocs.akamai.com/adaptive-media-delivery/docs/early-data-0-rtt.md) - [Edge IP Binding](https://techdocs.akamai.com/adaptive-media-delivery/docs/add-edge-ip-binding.md) - [EdgeWorkers](https://techdocs.akamai.com/adaptive-media-delivery/docs/add-edgeworkers.md) - [Enhanced Debug](https://techdocs.akamai.com/adaptive-media-delivery/docs/enhanced-debug.md) - [Enhanced Proxy Detection](https://techdocs.akamai.com/adaptive-media-delivery/docs/add-enhanced-proxy-detn.md) - [HTTP to HTTPS Upgrade](https://techdocs.akamai.com/adaptive-media-delivery/docs/upgrade-req-http-https.md) - [Low Latency Streaming support](https://techdocs.akamai.com/adaptive-media-delivery/docs/add-low-latency-support.md) - [DASH and a Media Services Live origin](https://techdocs.akamai.com/adaptive-media-delivery/docs/dash-and-msl-origin.md) - [HLS and a third-party origin](https://techdocs.akamai.com/adaptive-media-delivery/docs/hls-and-third-party-origin.md) - [Manifest Personalization for DASH](https://techdocs.akamai.com/adaptive-media-delivery/docs/add-manifest-personalization-dash.md) - [Manifest Personalization for HLS](https://techdocs.akamai.com/adaptive-media-delivery/docs/add-manifest-personalization-for-hls.md) - [Media Encryption](https://techdocs.akamai.com/adaptive-media-delivery/docs/add-media-enc.md) - [Set up ME for DASH](https://techdocs.akamai.com/adaptive-media-delivery/docs/set-up-me-for-dash.md) - [Set up ME for HLS](https://techdocs.akamai.com/adaptive-media-delivery/docs/set-up-me-for-hls.md) - [Set up ME for both](https://techdocs.akamai.com/adaptive-media-delivery/docs/set-up-me-for-both.md) - [Mixed Mode](https://techdocs.akamai.com/adaptive-media-delivery/docs/use-mixed-mode-amd.md) - [Existing properties and MMC](https://techdocs.akamai.com/adaptive-media-delivery/docs/existing-properties-and-mmc.md) - [Live & on-demand: Different Property Hostnames](https://techdocs.akamai.com/adaptive-media-delivery/docs/live-and-on-demand-different-property-hostnames.md) - [Live & on-demand: One property hostname, different URL paths](https://techdocs.akamai.com/adaptive-media-delivery/docs/live-on-demand-one-property-hostname-different-url-paths.md) - [Separate origins using different auth methods](https://techdocs.akamai.com/adaptive-media-delivery/docs/separate-origins-using-different-auth-methods.md) - [Optimize via different Content Characteristics](https://techdocs.akamai.com/adaptive-media-delivery/docs/optimize-via-different-content-characteristics.md) - [Optimize via different Client Characteristics](https://techdocs.akamai.com/adaptive-media-delivery/docs/optimize-via-different-client-characteristics.md) - [Known limitations with MMC](https://techdocs.akamai.com/adaptive-media-delivery/docs/known-limitations-with-mmc.md) - [Origin IP access control list](https://techdocs.akamai.com/adaptive-media-delivery/docs/origin-ip-access-control-list-amd.md) - [Prefetching](https://techdocs.akamai.com/adaptive-media-delivery/docs/add-prefetching.md) - [Origin-assist prefetch](https://techdocs.akamai.com/adaptive-media-delivery/docs/origin-assist-prefetch.md) - [Protect connections with mTLS](https://techdocs.akamai.com/adaptive-media-delivery/docs/protect-connections-with-mtls.md) - [Protocol Downgrade](https://techdocs.akamai.com/adaptive-media-delivery/docs/add-protocol-downgrade.md) - [No personally identifiable information (PII)](https://techdocs.akamai.com/adaptive-media-delivery/docs/no-personally-identifiable-information-pii.md) - [Protocol Downgrade for Enhanced TLS](https://techdocs.akamai.com/adaptive-media-delivery/docs/the-legacy-protocol-downgrade-behavior.md) - [Protocol Downgrade for Standard TLS](https://techdocs.akamai.com/adaptive-media-delivery/docs/add-protocol-downgrade-to-a-new-configuration.md) - [Migrate from Enhanced TLS to Standard TLS](https://techdocs.akamai.com/adaptive-media-delivery/docs/migrate-from-enhanced-tls-to-standard-tls.md) - [Quick Retry](https://techdocs.akamai.com/adaptive-media-delivery/docs/add-quick-retry.md) - [Caveats and known issues with Quick Retry](https://techdocs.akamai.com/adaptive-media-delivery/docs/caveats-and-known-issues-with-quick-retry.md) - [SureRoute](https://techdocs.akamai.com/adaptive-media-delivery/docs/sureroute.md) - [Token Authentication](https://techdocs.akamai.com/adaptive-media-delivery/docs/add-token-auth.md) - [Enable Token Authentication](https://techdocs.akamai.com/adaptive-media-delivery/docs/enable-token-authentication.md) - [Generate and apply a token](https://techdocs.akamai.com/adaptive-media-delivery/docs/generate-a-token-and-apply-it-to-content.md) - [Caveats and known issues with Token Auth](https://techdocs.akamai.com/adaptive-media-delivery/docs/caveats-and-know-issues-with-token-auth.md) - [Token-based Access Revocation](https://techdocs.akamai.com/adaptive-media-delivery/docs/add-token-based-access-rev.md) - [Watermarking](https://techdocs.akamai.com/adaptive-media-delivery/docs/add-wmk.md) - [Watermarking-supported media formats](https://techdocs.akamai.com/adaptive-media-delivery/docs/watermarking-supported-media-formats.md) - [Set up a watermarking vendor](https://techdocs.akamai.com/adaptive-media-delivery/docs/set-up-a-watermarking-vendor.md) - [Source content "preprocessing"](https://techdocs.akamai.com/adaptive-media-delivery/docs/source-content-preprocessing.md) - [The watermarking token (WMT)](https://techdocs.akamai.com/adaptive-media-delivery/docs/the-watermarking-token-wmt.md) - [Set up watermarking in your AMD property](https://techdocs.akamai.com/adaptive-media-delivery/docs/set-up-watermarking-in-your-amd-property.md) - [Set up your player for watermarking](https://techdocs.akamai.com/adaptive-media-delivery/docs/set-up-your-player-for-watermarking.md) - [Set up for non-watermarked content](https://techdocs.akamai.com/adaptive-media-delivery/docs/set-up-for-non-watermarked-content.md) - [Watermarking with Access Revocation](https://techdocs.akamai.com/adaptive-media-delivery/docs/watermarking-with-access-revocation.md) - [Key considerations with watermarking](https://techdocs.akamai.com/adaptive-media-delivery/docs/key-considerations-with-watermarking.md) - [Mapping Solution – Media Delivery Type](https://techdocs.akamai.com/adaptive-media-delivery/docs/add-use-case-based-edge-mapping.md) - [Method 1: One to one](https://techdocs.akamai.com/adaptive-media-delivery/docs/method-1-one-to-one.md) - [Method 2: One to many](https://techdocs.akamai.com/adaptive-media-delivery/docs/method-2-one-to-many.md) - [Edit edge hostnames to use Media Delivery Type](https://techdocs.akamai.com/adaptive-media-delivery/docs/edit-edge-hostnames-to-use-ucem.md) - [Mismatch issues and Media delivery type](https://techdocs.akamai.com/adaptive-media-delivery/docs/mismatch-issues-and-ucem.md) - [The Vary HTTP header](https://techdocs.akamai.com/adaptive-media-delivery/docs/include-vary-http-header.md) - [View reports for AMD](https://techdocs.akamai.com/adaptive-media-delivery/docs/view-reports.md) - [AMD service-level agreement](https://techdocs.akamai.com/adaptive-media-delivery/docs/sla-amd.md) ## API Reference - [Adaptive Media Delivery APIs](https://techdocs.akamai.com/adaptive-media-delivery/reference/adaptive-media-apis.md) - [Access Revocation API](https://techdocs.akamai.com/adaptive-media-delivery/reference/api.md) - [API summary](https://techdocs.akamai.com/adaptive-media-delivery/reference/api-summary.md) - [Get started](https://techdocs.akamai.com/adaptive-media-delivery/reference/get-started.md) - [Concepts](https://techdocs.akamai.com/adaptive-media-delivery/reference/concepts.md) - [API workflow](https://techdocs.akamai.com/adaptive-media-delivery/reference/api-workflow.md) - [Rate limiting](https://techdocs.akamai.com/adaptive-media-delivery/reference/rate-limiting.md) - [Errors](https://techdocs.akamai.com/adaptive-media-delivery/reference/api-errors.md) - [400](https://techdocs.akamai.com/adaptive-media-delivery/reference/400.md) - [401](https://techdocs.akamai.com/adaptive-media-delivery/reference/401.md) - [403](https://techdocs.akamai.com/adaptive-media-delivery/reference/403.md) - [404](https://techdocs.akamai.com/adaptive-media-delivery/reference/404.md) - [405](https://techdocs.akamai.com/adaptive-media-delivery/reference/405.md) - [415](https://techdocs.akamai.com/adaptive-media-delivery/reference/415.md) - [429](https://techdocs.akamai.com/adaptive-media-delivery/reference/429.md) - [500](https://techdocs.akamai.com/adaptive-media-delivery/reference/500.md) - [Add a revocation list](https://techdocs.akamai.com/adaptive-media-delivery/reference/post-revocation-list.md): Add a new list to house token identifiers that you want revoked from access. You can have a total of 10 revocation lists. You can't modify these settings for a revocation list, so be sure you provide the proper details when adding one. However, you can [revoke](ref:post-revocation-list-ids) or [unrevoke](ref:post-unrevoke-revocation-list-ids) token identifiers from each revocation list, as necessary. - [List revocation lists](https://techdocs.akamai.com/adaptive-media-delivery/reference/get-revocation-lists.md): List all of your revocation lists and view details about them. - [Delete a revocation list](https://techdocs.akamai.com/adaptive-media-delivery/reference/delete-revocation-list.md): Delete a specific revocation list. This removes support for Access Revocation in any AMD property that may have this revocation list currently selected for use. - [List identifiers](https://techdocs.akamai.com/adaptive-media-delivery/reference/get-revocation-list-ids.md): List all identifiers for a specific revocation list to review their details. - [Revoke tokens](https://techdocs.akamai.com/adaptive-media-delivery/reference/post-revocation-list-ids.md): Add a set of token identifiers to a revocation list to revoke them. Add up to 5,000 token identifiers in a single operation. - [Unrevoke tokens](https://techdocs.akamai.com/adaptive-media-delivery/reference/post-unrevoke-revocation-list-ids.md): Remove token identifiers from a revocation list. - [Get an identifier](https://techdocs.akamai.com/adaptive-media-delivery/reference/get-revocation-list-token.md): Get a specific identifier that belongs to a revocation list and review its details. - [Get a revocation list's identifier count](https://techdocs.akamai.com/adaptive-media-delivery/reference/get-revocation-list-meta.md): Get the current count and maximum number of identifiers allowed in the revocation list. - [List revocation list ARL properties](https://techdocs.akamai.com/adaptive-media-delivery/reference/get-revocation-list-properties.md): Get Property Manager-specific information for AMD properties that use this revocation list. ## Recipes - [Add a revocation list](https://techdocs.akamai.com/adaptive-media-delivery/recipes/add-a-revocation-list.md) - [Delete a revocation list](https://techdocs.akamai.com/adaptive-media-delivery/recipes/delete-a-revocation-list.md) - [Get an identifier](https://techdocs.akamai.com/adaptive-media-delivery/recipes/get-an-identifier.md) - [Get revocation list identifier count information](https://techdocs.akamai.com/adaptive-media-delivery/recipes/get-revocation-list-identifier-count-information.md) - [Get revocation lists](https://techdocs.akamai.com/adaptive-media-delivery/recipes/get-revocation-lists.md) - [List identifiers](https://techdocs.akamai.com/adaptive-media-delivery/recipes/list-identifiers.md) - [List revocation list ARL properties](https://techdocs.akamai.com/adaptive-media-delivery/recipes/list-revocation-list-arl-properties.md) - [Revoke tokens](https://techdocs.akamai.com/adaptive-media-delivery/recipes/revoke-tokens.md) - [Unrevoke tokens](https://techdocs.akamai.com/adaptive-media-delivery/recipes/unrevoke-tokens.md) ## Changelog - [Oct 8, 2024 – Update to Origin IP ACL support](https://techdocs.akamai.com/adaptive-media-delivery/changelog/oct-8-2024-update-to-origin-ip-acl-support.md) - [Sep 30, 2024 – New Enhanced Debug and Early Data behaviors](https://techdocs.akamai.com/adaptive-media-delivery/changelog/sep-30-2024-new-enhanced-debug-and-early-data-behaviors.md) - [Jan 11, 2024 – Client Hints support](https://techdocs.akamai.com/adaptive-media-delivery/changelog/jan-11-2024-client-hints-support.md) - [Dec 18, 2023 — Support for mTLS](https://techdocs.akamai.com/adaptive-media-delivery/changelog/dec-18-2023-support-for-mtls.md) - [Nov 16, 2023 – CMCD segment prefetching](https://techdocs.akamai.com/adaptive-media-delivery/changelog/nov-16-2023-cmcd-segment-prefetching.md) # Adaptive Media Player 2 powered by Bitmovin Documentation > Adaptive Media Player 2 (AMP2), powered by Bitmovin, delivers multiplatform video SDKs with comprehensive analytics built directly into each player, providing unified insights across your users' platforms. ## Guides - [Welcome to Adaptive Media Player 2](https://techdocs.akamai.com/amp2-bitmovin/docs/welcome-to-amp2.md) - [Adaptive Media Player 2 overview](https://techdocs.akamai.com/amp2-bitmovin/docs/amp2-overview.md) - [AMP1 vs. AMP2 comparison](https://techdocs.akamai.com/amp2-bitmovin/docs/amp1-amp2-comparison.md) - [AMP2 SDK tiers](https://techdocs.akamai.com/amp2-bitmovin/docs/amp2-tiers.md) - [Migration guide](https://techdocs.akamai.com/amp2-bitmovin/docs/migration-guide.md) - [Migrate Web SDK](https://techdocs.akamai.com/amp2-bitmovin/docs/migrate-web.md) - [Event mapping for Web SDK](https://techdocs.akamai.com/amp2-bitmovin/docs/event-mapping-web.md) - [API method mapping for Web SDK](https://techdocs.akamai.com/amp2-bitmovin/docs/api-method-mapping-web.md) - [Property mapping](https://techdocs.akamai.com/amp2-bitmovin/docs/property-mapping-web.md) - [Comprehensive coverage analysis](https://techdocs.akamai.com/amp2-bitmovin/docs/coverage-analysis.md) - [Migrate Android SDK](https://techdocs.akamai.com/amp2-bitmovin/docs/migrate-android.md) - [Event mapping for Android SDK](https://techdocs.akamai.com/amp2-bitmovin/docs/event-mapping-android.md) - [Player method mapping for Android SDK](https://techdocs.akamai.com/amp2-bitmovin/docs/player-method-mapping-android.md) - [Migrate iOS SDK](https://techdocs.akamai.com/amp2-bitmovin/docs/migrate-ios.md) - [Validate your migration](https://techdocs.akamai.com/amp2-bitmovin/docs/validate-migration.md) - [Phase 1: Development tests](https://techdocs.akamai.com/amp2-bitmovin/docs/phase-1-development-tests.md) - [Phase 2: User Acceptance Tests](https://techdocs.akamai.com/amp2-bitmovin/docs/phase-2-uats.md) # Akamai Cloud Documentation > Use Akamai cloud computing (formerly Linode) to build, deploy, and scale your modern applications faster and easier on the Akamai Connected Cloud. ## Guides - [Welcome to Akamai Cloud](https://techdocs.akamai.com/cloud-computing/docs/welcome.md) - [Get started](https://techdocs.akamai.com/cloud-computing/docs/getting-started.md) - [Choose a data center](https://techdocs.akamai.com/cloud-computing/docs/how-to-choose-a-data-center.md) - [Network transfer usage and costs](https://techdocs.akamai.com/cloud-computing/docs/network-transfer-usage-and-costs.md) - [Help & support](https://techdocs.akamai.com/cloud-computing/docs/help-and-support.md) - [Send email on Akamai Cloud](https://techdocs.akamai.com/cloud-computing/docs/send-email.md) - [Subscribe to status updates](https://techdocs.akamai.com/cloud-computing/docs/subscribe-to-status-updates.md) - [Grant a developer access to your services](https://techdocs.akamai.com/cloud-computing/docs/grant-a-developer-access.md) - [Automate cloud resource deployment](https://techdocs.akamai.com/cloud-computing/docs/automate-cloud-resource-deployment.md) - [Resell services](https://techdocs.akamai.com/cloud-computing/docs/resell-services.md) - [Partner Referrals (Beta)](https://techdocs.akamai.com/cloud-computing/docs/partner-referrals-beta.md) - [Distributed compute regions (limited availability)](https://techdocs.akamai.com/cloud-computing/docs/distributed-compute-regions.md) - [Supported services](https://techdocs.akamai.com/cloud-computing/docs/supported-services-distributed.md) - [Plans](https://techdocs.akamai.com/cloud-computing/docs/plans-distributed.md) - [IP Sharing and failover in distributed compute regions](https://techdocs.akamai.com/cloud-computing/docs/ip-sharing-distributed.md) - [Create a Linode in a distributed compute region](https://techdocs.akamai.com/cloud-computing/docs/create-compute-instance-distributed.md) - [New data centers 2026](https://techdocs.akamai.com/cloud-computing/docs/new-data-centers-beta-2026.md) - [NVIDIA RTX PRO 6000 Blackwell GPU Onboarding (limited availability)](https://techdocs.akamai.com/cloud-computing/docs/nvidia-rtx-pro-6000-blackwell-gpu-onboarding.md) - [Profile](https://techdocs.akamai.com/cloud-computing/docs/profile.md) - [Security controls for user accounts](https://techdocs.akamai.com/cloud-computing/docs/security-controls-for-user-accounts.md) - [Manage 2FA on a user account](https://techdocs.akamai.com/cloud-computing/docs/manage-2fa.md) - [Enable third-party authentication on your user account](https://techdocs.akamai.com/cloud-computing/docs/enable-third-party-authentication.md) - [Manage SSH keys](https://techdocs.akamai.com/cloud-computing/docs/manage-ssh-keys.md) - [Manage personal access tokens](https://techdocs.akamai.com/cloud-computing/docs/manage-personal-access-tokens.md) - [Reset your user password](https://techdocs.akamai.com/cloud-computing/docs/reset-your-user-password.md) - [Profile FAQ](https://techdocs.akamai.com/cloud-computing/docs/faqs-for-creating-and-managing-linode-accounts.md) - [Administration](https://techdocs.akamai.com/cloud-computing/docs/administration.md) - [Manage users on your account](https://techdocs.akamai.com/cloud-computing/docs/manage-users-on-your-account.md) - [Change your email address on your account](https://techdocs.akamai.com/cloud-computing/docs/change-your-email-address.md) - [Transfer services to a different account](https://techdocs.akamai.com/cloud-computing/docs/transfer-services-to-a-different-account.md) - [Parent and child accounts for Akamai partners](https://techdocs.akamai.com/cloud-computing/docs/parent-and-child-accounts-for-akamai-partners.md) - [Select network interfaces for new Linodes ](https://techdocs.akamai.com/cloud-computing/docs/select-network-interfaces-for-new-linodes.md) - [Select default Cloud Firewalls for new Linodes](https://techdocs.akamai.com/cloud-computing/docs/select-default-firewalls-for-new-linodes.md) - [Cancel your account](https://techdocs.akamai.com/cloud-computing/docs/cancel-an-account.md) - [Quotas](https://techdocs.akamai.com/cloud-computing/docs/quotas.md) - [Billing](https://techdocs.akamai.com/cloud-computing/docs/understanding-how-billing-works.md) - [Access billing information](https://techdocs.akamai.com/cloud-computing/docs/access-billing-information.md) - [View invoices and payment history](https://techdocs.akamai.com/cloud-computing/docs/view-invoices-and-payment-history.md) - [Update billing contact information](https://techdocs.akamai.com/cloud-computing/docs/update-billing-contact-information.md) - [Make a payment](https://techdocs.akamai.com/cloud-computing/docs/make-a-payment.md) - [Manage payment methods](https://techdocs.akamai.com/cloud-computing/docs/manage-payment-methods.md) - [Stop further billing](https://techdocs.akamai.com/cloud-computing/docs/stop-further-billing.md) - [Tax information](https://techdocs.akamai.com/cloud-computing/docs/tax-information.md) - [Referral program](https://techdocs.akamai.com/cloud-computing/docs/referral-program.md) - [Add a promo code](https://techdocs.akamai.com/cloud-computing/docs/add-a-promo-code.md) - [Billing FAQ](https://techdocs.akamai.com/cloud-computing/docs/billing-faqs.md) - [Identity and Access in Akamai Cloud](https://techdocs.akamai.com/cloud-computing/docs/identity-and-access-cm.md) - [Migration from grants to Identity and Access](https://techdocs.akamai.com/cloud-computing/docs/migration-grants-identity-and-access.md) - [Grants vs RBAC model comparison: Linodes example](https://techdocs.akamai.com/cloud-computing/docs/cloud-iam-rbac-vs-grant-linodes.md) - [Manage user access](https://techdocs.akamai.com/cloud-computing/docs/identity-access-cm-manage-access.md) - [Available roles](https://techdocs.akamai.com/cloud-computing/docs/identity-access-cm-available-roles.md) - [Single sign-on for Akamai Cloud](https://techdocs.akamai.com/cloud-computing/docs/single-sign-on-cm.md) - [Configure single sign-on (beta)](https://techdocs.akamai.com/cloud-computing/docs/sso-cm-configuration.md) - [Enable single sign-on ](https://techdocs.akamai.com/cloud-computing/docs/enable-single-sign-on.md) - [Enforce single sign-on ](https://techdocs.akamai.com/cloud-computing/docs/enforce-single-sign-on.md) - [Test the IDP configuration ](https://techdocs.akamai.com/cloud-computing/docs/test-the-idp-configuration.md) - [Add SSO User Exceptions ](https://techdocs.akamai.com/cloud-computing/docs/add-emergency-access-accounts.md) - [Add SSO-required users](https://techdocs.akamai.com/cloud-computing/docs/add-sso-required-users.md) - [Configure IDP settings (beta)](https://techdocs.akamai.com/cloud-computing/docs/manage-idp-settings.md) - [Create an identity provider (IDP) configuration ](https://techdocs.akamai.com/cloud-computing/docs/create-an-identity-provider-idp-configuration.md) - [Manage certificates ](https://techdocs.akamai.com/cloud-computing/docs/manage-certificates.md) - [Delete an identity provider (IDP) configuration ](https://techdocs.akamai.com/cloud-computing/docs/delete-an-identity-provider-idp-configuration.md) - [Delegation for parent and child accounts](https://techdocs.akamai.com/cloud-computing/docs/parent-child-iam.md) - [Partners](https://techdocs.akamai.com/cloud-computing/docs/parent-child-partner.md) - [End customers](https://techdocs.akamai.com/cloud-computing/docs/parent-child-end-customer.md) - [Migrated partners](https://techdocs.akamai.com/cloud-computing/docs/parent-child-migration-partner.md) - [Migrated end customers](https://techdocs.akamai.com/cloud-computing/docs/parent-child-migration-end-customer.md) - [Identity and Access audit logs](https://techdocs.akamai.com/cloud-computing/docs/iam-aclp.md) - [Linodes](https://techdocs.akamai.com/cloud-computing/docs/compute-instance.md) - [Get started with Linodes](https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-compute-instances.md) - [Create a Linode](https://techdocs.akamai.com/cloud-computing/docs/create-a-compute-instance.md) - [Disk encryption](https://techdocs.akamai.com/cloud-computing/docs/local-disk-encryption.md) - [Set up and secure a Linode](https://techdocs.akamai.com/cloud-computing/docs/set-up-and-secure-a-compute-instance.md) - [Plans](https://techdocs.akamai.com/cloud-computing/docs/compute-instance-plan-types.md) - [Generational compute plans](https://techdocs.akamai.com/cloud-computing/docs/generational-compute-plans.md) - [Choose a compute plan](https://techdocs.akamai.com/cloud-computing/docs/how-to-choose-a-compute-instance-plan.md) - [Choose between shared and dedicated CPUs](https://techdocs.akamai.com/cloud-computing/docs/choosing-between-shared-and-dedicated-cpus.md) - [Dedicated CPU Linodes](https://techdocs.akamai.com/cloud-computing/docs/dedicated-cpu-compute-instances.md) - [Shared CPU Linodes](https://techdocs.akamai.com/cloud-computing/docs/shared-cpu-compute-instances.md) - [High Memory Linodes](https://techdocs.akamai.com/cloud-computing/docs/high-memory-compute-instances.md) - [Premium Linodes](https://techdocs.akamai.com/cloud-computing/docs/premium-compute-instances.md) - [Accelerated Linodes](https://techdocs.akamai.com/cloud-computing/docs/accelerated-compute-instances.md) - [GPU Linodes](https://techdocs.akamai.com/cloud-computing/docs/gpu-compute-instances.md) - [GPU selection guidance](https://techdocs.akamai.com/cloud-computing/docs/gpu-selection-guidance.md) - [vNUMA topology](https://techdocs.akamai.com/cloud-computing/docs/virtual-numa-topology.md) - [Install the NVIDIA CUDA toolkit on GPU Linodes](https://techdocs.akamai.com/cloud-computing/docs/install-the-nvidia-cuda-toolkit-on-gpu-compute-instances.md) - [Resize a Linode](https://techdocs.akamai.com/cloud-computing/docs/resize-a-compute-instance.md) - [Known limitations you may encounter with NVIDIA RTX PRO 6000 Blackwell Server Edition GPU Linodes](https://techdocs.akamai.com/cloud-computing/docs/known-limitations-you-may-encounter-with-nvidia-rtx-pro-6000-blackwell-server-edition-gpu-linodes.md) - [Choose a Linux distribution](https://techdocs.akamai.com/cloud-computing/docs/choose-a-distribution.md) - [Default distro packages](https://techdocs.akamai.com/cloud-computing/docs/default-distro-packages.md) - [Package mirrors](https://techdocs.akamai.com/cloud-computing/docs/package-mirrors.md) - [Manage disks and storage on a Linode](https://techdocs.akamai.com/cloud-computing/docs/manage-disks-on-a-compute-instance.md) - [Copy a disk over SSH](https://techdocs.akamai.com/cloud-computing/docs/copy-a-disk-over-ssh.md) - [Copy a disk to a different account](https://techdocs.akamai.com/cloud-computing/docs/copy-a-disk-to-a-different-account.md) - [Reset the root password on a Linode](https://techdocs.akamai.com/cloud-computing/docs/reset-the-root-password-on-a-compute-instance.md) - [Clone a Linode](https://techdocs.akamai.com/cloud-computing/docs/clone-a-compute-instance.md) - [Access your system console using Lish](https://techdocs.akamai.com/cloud-computing/docs/access-your-system-console-using-lish.md) - [Access your desktop environment using Glish](https://techdocs.akamai.com/cloud-computing/docs/access-your-desktop-environment-using-glish.md) - [Networking](https://techdocs.akamai.com/cloud-computing/docs/compute-instance-networking.md) - [Automatically configure networking (Network Helper)](https://techdocs.akamai.com/cloud-computing/docs/automatically-configure-networking.md) - [DNS resolvers](https://techdocs.akamai.com/cloud-computing/docs/dns-resolvers.md) - [Manage IP addresses on a Linode](https://techdocs.akamai.com/cloud-computing/docs/managing-ip-addresses-on-a-compute-instance.md) - [IPv6 on Linodes](https://techdocs.akamai.com/cloud-computing/docs/an-overview-of-ipv6-on-linode.md) - [Configure rDNS (reverse DNS) on a Linode](https://techdocs.akamai.com/cloud-computing/docs/configure-rdns-reverse-dns-on-a-compute-instance.md) - [Enable IP sharing (elastic IPs) in Atlanta through FRR](https://techdocs.akamai.com/cloud-computing/docs/enable-ip-sharing-elastic-ips-in-atlanta-through-frr.md) - [Configure failover on a Linode](https://techdocs.akamai.com/cloud-computing/docs/configure-failover-on-a-compute-instance.md) - [Configure IP failover over BGP using FRR (advanced)](https://techdocs.akamai.com/cloud-computing/docs/configuring-ip-failover-over-bgp-using-frr-advanced.md) - [Use keepalived health checks with BGP-based failover](https://techdocs.akamai.com/cloud-computing/docs/use-keepalived-health-checks-with-bgp-based-failover.md) - [Configure multi-queue NICs on Linodes](https://techdocs.akamai.com/cloud-computing/docs/multi-queue-nics.md) - [Manage configuration profiles on a Linode](https://techdocs.akamai.com/cloud-computing/docs/manage-configuration-profiles-on-a-compute-instance.md) - [Manage the kernel on a Linode](https://techdocs.akamai.com/cloud-computing/docs/manage-the-kernel-on-a-compute-instance.md) - [Networking interfaces](https://techdocs.akamai.com/cloud-computing/docs/networking-interface.md) - [Manage Linode interfaces ](https://techdocs.akamai.com/cloud-computing/docs/managing-linode-interfaces.md) - [Manage configuration profile interfaces ](https://techdocs.akamai.com/cloud-computing/docs/manage-configuration-profile-interfaces.md) - [Upgrade Configuration profile interfaces to Linode interfaces ](https://techdocs.akamai.com/cloud-computing/docs/upgrading-config-profile-interfaces-to-linode-interfaces.md) - [Manual network configuration on a Linode](https://techdocs.akamai.com/cloud-computing/docs/manual-network-configuration-on-a-compute-instance.md) - [Network configuration using NetworkManager](https://techdocs.akamai.com/cloud-computing/docs/network-configuration-using-networkmanager.md) - [Network configuration using Netplan](https://techdocs.akamai.com/cloud-computing/docs/network-configuration-using-netplan.md) - [Network configuration using ifupdown](https://techdocs.akamai.com/cloud-computing/docs/network-configuration-using-ifupdown.md) - [Network configuration using systemd-networkd](https://techdocs.akamai.com/cloud-computing/docs/network-configuration-using-systemd-networkd.md) - [Work with placement groups](https://techdocs.akamai.com/cloud-computing/docs/work-with-placement-groups.md) - [Monitor and maintain Linodes](https://techdocs.akamai.com/cloud-computing/docs/monitor-and-maintain-a-compute-instance.md) - [Configure email alerts for resource usage on Linodes](https://techdocs.akamai.com/cloud-computing/docs/configure-email-alerts-for-resource-usage-on-compute-instances.md) - [Linodes audit logs](https://techdocs.akamai.com/cloud-computing/docs/linodes-audit-logs.md) - [Update system packages](https://techdocs.akamai.com/cloud-computing/docs/update-packages.md) - [Recovery and troubleshooting](https://techdocs.akamai.com/cloud-computing/docs/troubleshooting-compute-instances.md) - [Recover from unexpected shutdowns with Lassie](https://techdocs.akamai.com/cloud-computing/docs/recover-from-unexpected-shutdowns-with-lassie.md) - [Rescue and rebuild](https://techdocs.akamai.com/cloud-computing/docs/rescue-and-rebuild.md) - [Troubleshooting general issues on Linodes](https://techdocs.akamai.com/cloud-computing/docs/troubleshooting-general-issues-on-compute-instances.md) - [Troubleshooting basic connection issues on Linodes](https://techdocs.akamai.com/cloud-computing/docs/troubleshooting-basic-connection-issues-on-compute-instances.md) - [Troubleshooting SSH on Linodes](https://techdocs.akamai.com/cloud-computing/docs/troubleshooting-ssh-on-compute-instances.md) - [Troubleshooting memory issues on Linodes](https://techdocs.akamai.com/cloud-computing/docs/troubleshooting-memory-issues-on-compute-instances.md) - [Troubleshooting firewall issues on Linodes](https://techdocs.akamai.com/cloud-computing/docs/troubleshooting-firewall-issues-on-compute-instances.md) - [Troubleshooting web servers, databases, and other services](https://techdocs.akamai.com/cloud-computing/docs/troubleshooting-web-servers.md) - [Migrations within Akamai Cloud](https://techdocs.akamai.com/cloud-computing/docs/compute-migrations.md) - [Migrate to a new data center](https://techdocs.akamai.com/cloud-computing/docs/migrate-to-a-new-data-center.md) - [Maintenance events and policies](https://techdocs.akamai.com/cloud-computing/docs/host-maintenance-policy.md) - [Linodes FAQs](https://techdocs.akamai.com/cloud-computing/docs/faqs-for-compute-instances.md) - [Linode Managed](https://techdocs.akamai.com/cloud-computing/docs/linode-managed.md) - [Get started with Linode Managed](https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-managed-service.md) - [Configure credentials for Linode Managed](https://techdocs.akamai.com/cloud-computing/docs/configure-credentials-for-linode-managed.md) - [Configure SSH access for Linode Managed](https://techdocs.akamai.com/cloud-computing/docs/configure-ssh-access-for-linode-managed.md) - [Configure firewall rules to allow access for Linode Managed](https://techdocs.akamai.com/cloud-computing/docs/configure-firewall-rules-to-allow-access-from-linode-infrastructure.md) - [Create and edit service monitors for Linode Managed](https://techdocs.akamai.com/cloud-computing/docs/create-and-edit-service-monitors-for-linode-managed.md) - [Manage contacts for Linode Managed](https://techdocs.akamai.com/cloud-computing/docs/manage-contacts-for-linode-managed.md) - [Cancel Linode Managed](https://techdocs.akamai.com/cloud-computing/docs/cancel-linode-managed.md) - [Linode Kubernetes Engine](https://techdocs.akamai.com/cloud-computing/docs/linode-kubernetes-engine.md) - [LKE Enterprise](https://techdocs.akamai.com/cloud-computing/docs/lke-enterprise.md) - [Known issues you may encounter with LKE Enterprise](https://techdocs.akamai.com/cloud-computing/docs/lke-enterprise-known-issues.md) - [Upgrade an LKE Enterprise cluster to a newer Kubernetes version](https://techdocs.akamai.com/cloud-computing/docs/upgrade-an-lke-enterprise-cluster-to-a-newer-kubernetes-version.md) - [Getting started with LKE](https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-lke-linode-kubernetes-engine.md) - [Create a cluster](https://techdocs.akamai.com/cloud-computing/docs/create-a-cluster.md) - [Manage Kubernetes clusters on LKE](https://techdocs.akamai.com/cloud-computing/docs/manage-kubernetes-clusters-on-lke.md) - [Manage nodes and node pools](https://techdocs.akamai.com/cloud-computing/docs/manage-nodes-and-node-pools.md) - [Kubernetes Dashboard on LKE](https://techdocs.akamai.com/cloud-computing/docs/an-overview-of-the-kubernetes-dashboard-on-lke.md) - [High availability (HA) control plane on LKE](https://techdocs.akamai.com/cloud-computing/docs/high-availability-ha-control-plane-on-lke.md) - [Manage a cluster with kubectl](https://techdocs.akamai.com/cloud-computing/docs/manage-a-cluster-with-kubectl.md) - [Kubernetes versioning and life cycle policy](https://techdocs.akamai.com/cloud-computing/docs/lke-versioning-and-life-cycle-policy.md) - [Labels and taints](https://techdocs.akamai.com/cloud-computing/docs/labels-and-taints.md) - [Using GPUs on LKE](https://techdocs.akamai.com/cloud-computing/docs/gpus-on-lke.md) - [Upgrade a cluster to a newer Kubernetes version](https://techdocs.akamai.com/cloud-computing/docs/upgrade-a-cluster-to-a-newer-kubernetes-version.md) - [Control Plane ACLs](https://techdocs.akamai.com/cloud-computing/docs/control-plane-acls.md) - [How to drain a node pool on an LKE cluster](https://techdocs.akamai.com/cloud-computing/docs/drain-a-node-pool-on-lke-cluster.md) - [Rotate Kubernetes secrets](https://techdocs.akamai.com/cloud-computing/docs/rotate-kubernetes-secrets.md) - [Reset kubeconfig](https://techdocs.akamai.com/cloud-computing/docs/reset-kubeconfig.md) - [Deploy and manage an LKE cluster with the Linode API](https://techdocs.akamai.com/cloud-computing/docs/deploy-and-manage-a-kubernetes-cluster-with-the-api.md) - [Load balancing on LKE](https://techdocs.akamai.com/cloud-computing/docs/get-started-with-load-balancing-on-an-lke-cluster.md) - [Secure a cluster with user permissions and RBAC](https://techdocs.akamai.com/cloud-computing/docs/secure-a-cluster-with-user-permissions-and-rbac.md) - [Network and firewall details](https://techdocs.akamai.com/cloud-computing/docs/lke-network-firewall-details.md) - [Create a custom CoreDNS configuration](https://techdocs.akamai.com/cloud-computing/docs/coredns-custom-config.md) - [Akamai App Platform (for LKE)](https://techdocs.akamai.com/cloud-computing/docs/application-platform.md) - [Getting Started with the Akamai App Platform](https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-akamai-application-platform.md) - [Metrics for LKE Enterprise](https://techdocs.akamai.com/cloud-computing/docs/lke-e-metrics.md) - [Metadata service](https://techdocs.akamai.com/cloud-computing/docs/overview-of-the-metadata-service.md) - [Add user data when deploying Linodes](https://techdocs.akamai.com/cloud-computing/docs/add-user-data-when-deploying-a-compute-instance.md) - [Access the Metadata service API](https://techdocs.akamai.com/cloud-computing/docs/access-the-metadata-service-api.md) - [Use the Metadata service API](https://techdocs.akamai.com/cloud-computing/docs/metadata-service-api.md) - [Use cloud-config files to configure a server](https://techdocs.akamai.com/cloud-computing/docs/using-cloud-config-files-to-configure-a-server.md) - [Troubleshoot issues with the Metadata service](https://techdocs.akamai.com/cloud-computing/docs/troubleshoot-metadata-service.md) - [Additional resources](https://techdocs.akamai.com/cloud-computing/docs/additional-resources.md) - [Images](https://techdocs.akamai.com/cloud-computing/docs/images.md) - [Capture an image](https://techdocs.akamai.com/cloud-computing/docs/capture-an-image.md) - [Upload an image](https://techdocs.akamai.com/cloud-computing/docs/upload-an-image.md) - [Replicate an image](https://techdocs.akamai.com/cloud-computing/docs/replicate-an-image.md) - [Deploy an image to a new Linode](https://techdocs.akamai.com/cloud-computing/docs/deploy-an-image-to-a-new-compute-instance.md) - [Deploy an image to an existing Linode](https://techdocs.akamai.com/cloud-computing/docs/deploy-an-image-to-an-existing-compute-instance.md) - [Backups](https://techdocs.akamai.com/cloud-computing/docs/backup-service.md) - [Get started with the Backups service](https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-backup-service.md) - [Enable backups](https://techdocs.akamai.com/cloud-computing/docs/enable-backups.md) - [Schedule backups](https://techdocs.akamai.com/cloud-computing/docs/schedule-backups.md) - [Take a manual snapshot](https://techdocs.akamai.com/cloud-computing/docs/take-a-manual-snapshot.md) - [Restore a backup to a new Linode](https://techdocs.akamai.com/cloud-computing/docs/restore-a-backup-to-a-new-compute-instance.md) - [Restore a backup to an existing Linode](https://techdocs.akamai.com/cloud-computing/docs/restore-a-backup-to-an-existing-compute-instance.md) - [Cancel backups](https://techdocs.akamai.com/cloud-computing/docs/cancel-backups.md) - [Troubleshoot issues with the Backups service](https://techdocs.akamai.com/cloud-computing/docs/troubleshooting-issues-with-the-backup-service.md) - [Download a local copy of a backup](https://techdocs.akamai.com/cloud-computing/docs/download-backups-locally.md) - [Backups FAQ](https://techdocs.akamai.com/cloud-computing/docs/faqs-for-the-backup-service.md) - [Block Storage](https://techdocs.akamai.com/cloud-computing/docs/block-storage.md) - [Get started with Block Storage](https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-block-storage.md) - [View, create, and delete Block Storage volumes](https://techdocs.akamai.com/cloud-computing/docs/manage-block-storage-volumes.md) - [Manage Block Storage volumes with the Linode API](https://techdocs.akamai.com/cloud-computing/docs/manage-block-storage-volumes-with-the-api.md) - [Volume Encryption](https://techdocs.akamai.com/cloud-computing/docs/volumes-disk-encryption.md) - [Attach and detach a volume](https://techdocs.akamai.com/cloud-computing/docs/attach-and-detach-a-volume.md) - [Resize a volume](https://techdocs.akamai.com/cloud-computing/docs/resize-a-volume.md) - [Configure and mount a volume](https://techdocs.akamai.com/cloud-computing/docs/configure-and-mount-a-volume.md) - [Boot from a Block Storage volume](https://techdocs.akamai.com/cloud-computing/docs/boot-from-a-block-storage-volume.md) - [Transfer Block Storage data between data centers](https://techdocs.akamai.com/cloud-computing/docs/transfer-block-storage-data-between-data-centers.md) - [Transfer a volume to a different Linode](https://techdocs.akamai.com/cloud-computing/docs/transfer-a-volume-to-a-different-compute-instance.md) - [Common Block Storage use cases](https://techdocs.akamai.com/cloud-computing/docs/common-use-cases-for-block-storage.md) - [Block Storage audit logs](https://techdocs.akamai.com/cloud-computing/docs/block-storage-audit-logs.md) - [Object Storage](https://techdocs.akamai.com/cloud-computing/docs/object-storage.md) - [Get started with Object Storage](https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-object-storage.md) - [Endpoint types](https://techdocs.akamai.com/cloud-computing/docs/endpoint-types.md) - [Object Storage quotas and limits](https://techdocs.akamai.com/cloud-computing/docs/object-storage-product-limits.md) - [Pricing](https://techdocs.akamai.com/cloud-computing/docs/object-storage-pricing.md) - [Create and manage buckets](https://techdocs.akamai.com/cloud-computing/docs/create-and-manage-buckets.md) - [Upload and manage files (objects)](https://techdocs.akamai.com/cloud-computing/docs/upload-and-manage-files-objects.md) - [Access buckets and files through URLs](https://techdocs.akamai.com/cloud-computing/docs/access-buckets-and-files-through-urls.md) - [Object Storage use cases](https://techdocs.akamai.com/cloud-computing/docs/use-cases-for-object-storage.md) - [Access keys for Object Storage](https://techdocs.akamai.com/cloud-computing/docs/manage-access-keys.md) - [Define access and permissions using bucket policies](https://techdocs.akamai.com/cloud-computing/docs/define-access-and-permissions-using-bucket-policies.md) - [Define access and permissions using ACLs (Access Control Lists)](https://techdocs.akamai.com/cloud-computing/docs/define-access-and-permissions-using-acls-access-control-lists.md) - [Lifecycle policies](https://techdocs.akamai.com/cloud-computing/docs/lifecycle-policies.md) - [Use tags and prefixes in lifecycle policies to delete objects](https://techdocs.akamai.com/cloud-computing/docs/use-tags-and-prefixes-in-lifecycle-policies-to-delete-objects.md) - [Find the canonical user ID for an account](https://techdocs.akamai.com/cloud-computing/docs/find-the-canonical-user-id-for-an-account.md) - [Configure a custom domain with a TLS/SSL certificate](https://techdocs.akamai.com/cloud-computing/docs/configure-a-custom-domain-with-a-tls-ssl-certificate.md) - [Clients and tooling](https://techdocs.akamai.com/cloud-computing/docs/clients-and-tooling.md) - [AWS CLI and SDKs support details](https://techdocs.akamai.com/cloud-computing/docs/aws-cli-sdks-support-details.md) - [Use the Linode CLI with Object Storage](https://techdocs.akamai.com/cloud-computing/docs/using-the-linode-cli-with-object-storage.md) - [Use s3cmd with Object Storage](https://techdocs.akamai.com/cloud-computing/docs/using-s3cmd-with-object-storage.md) - [Use s4cmd with Object Storage](https://techdocs.akamai.com/cloud-computing/docs/using-s4cmd-with-object-storage.md) - [Use Cyberduck with Object Storage](https://techdocs.akamai.com/cloud-computing/docs/using-cyberduck-with-object-storage.md) - [Use the AWS CLI with Object Storage](https://techdocs.akamai.com/cloud-computing/docs/using-the-aws-cli-with-object-storage.md) - [Use the AWS SDK for PHP with Object Storage](https://techdocs.akamai.com/cloud-computing/docs/using-the-aws-sdk-for-php-with-object-storage.md) - [Use the AWS SDK for Python (boto3) with Object Storage](https://techdocs.akamai.com/cloud-computing/docs/using-the-aws-sdk-for-python-boto3-with-object-storage.md) - [Use Grafana Loki with Object Storage](https://techdocs.akamai.com/cloud-computing/docs/using-grafana-loki-with-object-storage.md) - [Best practices for high-throughput applications](https://techdocs.akamai.com/cloud-computing/docs/object-storage-best-practices.md) - [Data protection](https://techdocs.akamai.com/cloud-computing/docs/data-protection.md) - [Use Object Lock to protect data](https://techdocs.akamai.com/cloud-computing/docs/protect-data-with-object-lock.md) - [Versioning (retain object version history)](https://techdocs.akamai.com/cloud-computing/docs/versioning-retain-object-version-history.md) - [Data durability](https://techdocs.akamai.com/cloud-computing/docs/data-durability.md) - [Designing deployments for high-availability and disaster recovery](https://techdocs.akamai.com/cloud-computing/docs/designing-deployments-for-high-availability-and-disaster-recovery.md) - [Monitor Object Storage](https://techdocs.akamai.com/cloud-computing/docs/monitor-object-storage.md) - [Metrics for Object Storage](https://techdocs.akamai.com/cloud-computing/docs/object-storage-cloud-pulse-metrics.md) - [Logs for Object Storage](https://techdocs.akamai.com/cloud-computing/docs/logs-for-object-storage.md) - [Cancel Object Storage](https://techdocs.akamai.com/cloud-computing/docs/cancel-object-storage.md) - [Linode Cloud Firewalls](https://techdocs.akamai.com/cloud-computing/docs/cloud-firewall.md) - [Getting started with Cloud Firewalls](https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-cloud-firewalls.md) - [Create a Cloud Firewall](https://techdocs.akamai.com/cloud-computing/docs/create-a-cloud-firewall.md) - [Manage firewall rules](https://techdocs.akamai.com/cloud-computing/docs/manage-firewall-rules.md) - [Apply firewall rules to a Linode, Linode Interface, or NodeBalancer](https://techdocs.akamai.com/cloud-computing/docs/apply-firewall-rules-to-a-service.md) - [Update Cloud Firewall status](https://techdocs.akamai.com/cloud-computing/docs/update-cloud-firewall-status.md) - [Comparing Cloud Firewalls to Linux firewall software](https://techdocs.akamai.com/cloud-computing/docs/comparing-cloud-firewalls-to-linux-firewall-software.md) - [Delete a Cloud Firewall](https://techdocs.akamai.com/cloud-computing/docs/delete-a-cloud-firewall.md) - [Cloud Firewalls audit logs](https://techdocs.akamai.com/cloud-computing/docs/firewalls-audit-logs.md) - [NodeBalancers](https://techdocs.akamai.com/cloud-computing/docs/nodebalancer.md) - [Introduction to load balancing](https://techdocs.akamai.com/cloud-computing/docs/introduction-to-load-balancing.md) - [Getting started with NodeBalancers](https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-nodebalancers.md) - [Create a NodeBalancer](https://techdocs.akamai.com/cloud-computing/docs/create-a-nodebalancer.md) - [Configuration options for NodeBalancers](https://techdocs.akamai.com/cloud-computing/docs/configuration-options-for-nodebalancers.md) - [Using Proxy Protocol with NodeBalancers](https://techdocs.akamai.com/cloud-computing/docs/using-proxy-protocol-with-nodebalancers.md) - [Available protocols](https://techdocs.akamai.com/cloud-computing/docs/available-protocols.md) - [Client's IP address pass-through](https://techdocs.akamai.com/cloud-computing/docs/clients-ip-address-pass-through.md) - [Backend nodes](https://techdocs.akamai.com/cloud-computing/docs/back-end-nodes-compute-instances.md) - [TLS/SSL termination on NodeBalancers](https://techdocs.akamai.com/cloud-computing/docs/tls-ssl-termination-on-nodebalancers.md) - [Manage NodeBalancers](https://techdocs.akamai.com/cloud-computing/docs/manage-nodebalancers.md) - [Monitor NodeBalancers](https://techdocs.akamai.com/cloud-computing/docs/monitor-nodebalancers.md) - [NodeBalancers metrics](https://techdocs.akamai.com/cloud-computing/docs/nodebalancers-metrics.md) - [NodeBalancers audit logs](https://techdocs.akamai.com/cloud-computing/docs/nodebalancers-audit-logs.md) - [Configure NodeBalancers with the Linode API](https://techdocs.akamai.com/cloud-computing/docs/configure-nodebalancers-with-the-api.md) - [DNS Manager](https://techdocs.akamai.com/cloud-computing/docs/dns-manager.md) - [Getting started with DNS manager](https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-dns-manager.md) - [Create a domain](https://techdocs.akamai.com/cloud-computing/docs/create-a-domain.md) - [DNS record types](https://techdocs.akamai.com/cloud-computing/docs/dns-record-types.md) - [A and AAAA records](https://techdocs.akamai.com/cloud-computing/docs/a-and-aaaa-records.md) - [CNAME records](https://techdocs.akamai.com/cloud-computing/docs/cname-records.md) - [MX records](https://techdocs.akamai.com/cloud-computing/docs/mx-records.md) - [TXT records](https://techdocs.akamai.com/cloud-computing/docs/txt-records.md) - [NS records](https://techdocs.akamai.com/cloud-computing/docs/ns-records.md) - [SOA record](https://techdocs.akamai.com/cloud-computing/docs/soa-record.md) - [CAA records](https://techdocs.akamai.com/cloud-computing/docs/caa-records.md) - [SRV records](https://techdocs.akamai.com/cloud-computing/docs/srv-records.md) - [Manage domains](https://techdocs.akamai.com/cloud-computing/docs/manage-domains.md) - [Manage DNS records](https://techdocs.akamai.com/cloud-computing/docs/manage-dns-records.md) - [Configure your domain's authoritative name servers](https://techdocs.akamai.com/cloud-computing/docs/configure-your-domains-authoritative-name-servers.md) - [Incoming DNS zone transfers](https://techdocs.akamai.com/cloud-computing/docs/incoming-dns-zone-transfers.md) - [Outgoing DNS zone transfers](https://techdocs.akamai.com/cloud-computing/docs/outgoing-dns-zone-transfers.md) - [Troubleshooting DNS records](https://techdocs.akamai.com/cloud-computing/docs/troubleshooting-dns-records.md) - [Common DNS configurations](https://techdocs.akamai.com/cloud-computing/docs/common-dns-configurations.md) - [VPC](https://techdocs.akamai.com/cloud-computing/docs/vpc.md) - [Getting started with VPC](https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-vpc.md) - [Create a VPC](https://techdocs.akamai.com/cloud-computing/docs/create-a-vpc.md) - [Manage VPCs](https://techdocs.akamai.com/cloud-computing/docs/manage-vpcs.md) - [Manage VPC subnets](https://techdocs.akamai.com/cloud-computing/docs/manage-vpc-subnets.md) - [Assign a Linode to a VPC](https://techdocs.akamai.com/cloud-computing/docs/assign-a-compute-instance-to-a-vpc.md) - [Configure a forward proxy to enable internet access within a VPC](https://techdocs.akamai.com/cloud-computing/docs/forward-proxy-for-vpc.md) - [VPC audit logs](https://techdocs.akamai.com/cloud-computing/docs/vpc-audit-logs.md) - [VLANs](https://techdocs.akamai.com/cloud-computing/docs/vlan.md) - [Getting started with VLANs](https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-vlans.md) - [Attach a VLAN to a Linode](https://techdocs.akamai.com/cloud-computing/docs/attach-a-vlan-to-a-compute-instance.md) - [Detach or delete a VLAN from a Linode](https://techdocs.akamai.com/cloud-computing/docs/detach-a-vlan-from-a-compute-instance.md) - [Manually configuring a VLAN on a Linode](https://techdocs.akamai.com/cloud-computing/docs/manually-configuring-a-vlan-on-a-compute-instance.md) - [Common use cases for VLANs](https://techdocs.akamai.com/cloud-computing/docs/common-use-cases-for-vlans.md) - [Create a private network with VLANs using the Linode API](https://techdocs.akamai.com/cloud-computing/docs/create-a-private-network-with-vlans-using-the-api.md) - [Reserved IPs](https://techdocs.akamai.com/cloud-computing/docs/reserved-ips.md) - [Getting started with reserved IPs](https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-reserved-ips.md) - [Reserve an IP address](https://techdocs.akamai.com/cloud-computing/docs/reserve-an-ip.md) - [Manage and assign reserved IPs](https://techdocs.akamai.com/cloud-computing/docs/managing-reserved-ips.md) - [Managed database clusters](https://techdocs.akamai.com/cloud-computing/docs/aiven-database-clusters.md) - [Get started with managed databases](https://techdocs.akamai.com/cloud-computing/docs/get-started-new-clusters.md) - [Database engines and plans](https://techdocs.akamai.com/cloud-computing/docs/database-engines-plans.md) - [Create and manage database clusters](https://techdocs.akamai.com/cloud-computing/docs/aiven-manage-database.md) - [Advanced configuration parameters](https://techdocs.akamai.com/cloud-computing/docs/advanced-configuration-parameters.md) - [Monitor Managed Databases](https://techdocs.akamai.com/cloud-computing/docs/monitor-databases.md) - [Managed Databases metrics (limited availability)](https://techdocs.akamai.com/cloud-computing/docs/databases-metrics.md) - [MySQL](https://techdocs.akamai.com/cloud-computing/docs/aiven-mysql.md) - [PostgreSQL](https://techdocs.akamai.com/cloud-computing/docs/aiven-postgresql.md) - [Monitor cloud services](https://techdocs.akamai.com/cloud-computing/docs/akamai-cloud-pulse.md) - [Monitoring concepts and terminology](https://techdocs.akamai.com/cloud-computing/docs/aclp-key-concepts-and-terms.md) - [Metrics (limited availability)](https://techdocs.akamai.com/cloud-computing/docs/aclp-metrics.md) - [Metrics dashboards](https://techdocs.akamai.com/cloud-computing/docs/metrics-dashboards.md) - [View metrics for multiple entities](https://techdocs.akamai.com/cloud-computing/docs/use-centralized-dashboard.md) - [View metrics for a single entity](https://techdocs.akamai.com/cloud-computing/docs/use-entity-level-dashboards.md) - [Export metrics to external tools](https://techdocs.akamai.com/cloud-computing/docs/export-metrics-to-external-tools.md) - [Quick start: Metrics export](https://techdocs.akamai.com/cloud-computing/docs/otel-collector-get-started.md) - [Deployment methods](https://techdocs.akamai.com/cloud-computing/docs/otel-collector-deployment-methods.md) - [Receiver configuration](https://techdocs.akamai.com/cloud-computing/docs/otel-collector-receiver-configuration.md) - [API rate limits and request batching](https://techdocs.akamai.com/cloud-computing/docs/otel-collector-request-limits-batching.md) - [Hot reload configuration changes](https://techdocs.akamai.com/cloud-computing/docs/otel-collector-configuration-changes.md) - [Understanding missing metrics](https://techdocs.akamai.com/cloud-computing/docs/otel-collector-missing-metrics.md) - [Troubleshooting](https://techdocs.akamai.com/cloud-computing/docs/otel-collector-troubleshooting.md) - [FAQs](https://techdocs.akamai.com/cloud-computing/docs/otel-collector-faqs.md) - [Metrics reference](https://techdocs.akamai.com/cloud-computing/docs/metrics-dimensions-parameters.md) - [Alerts (limited availability)](https://techdocs.akamai.com/cloud-computing/docs/aclp-alerts.md) - [Alert types and settings](https://techdocs.akamai.com/cloud-computing/docs/alert-types-and-parameters.md) - [View an alert definition](https://techdocs.akamai.com/cloud-computing/docs/view-alert.md) - [Create a user alert](https://techdocs.akamai.com/cloud-computing/docs/create-user-alert.md) - [Edit an alert definition](https://techdocs.akamai.com/cloud-computing/docs/edit-alert.md) - [Enable or disable an alert](https://techdocs.akamai.com/cloud-computing/docs/enable-disable-alert.md) - [Clone an alert](https://techdocs.akamai.com/cloud-computing/docs/clone-alert.md) - [Delete an alert](https://techdocs.akamai.com/cloud-computing/docs/delete-alert.md) - [Change the monitored entities](https://techdocs.akamai.com/cloud-computing/docs/assign-unassign-entities.md) - [Manage notification channels](https://techdocs.akamai.com/cloud-computing/docs/manage-notification-channels.md) - [Logs](https://techdocs.akamai.com/cloud-computing/docs/log-delivery.md) - [Shared responsibilities](https://techdocs.akamai.com/cloud-computing/docs/logs-responsibilities.md) - [Get started with logs](https://techdocs.akamai.com/cloud-computing/docs/get-started-with-logs.md) - [Quick start: Audit logs](https://techdocs.akamai.com/cloud-computing/docs/quick-start-audit-logs.md) - [Quick start: Kubernetes API audit logs](https://techdocs.akamai.com/cloud-computing/docs/quick-start-kubernetes-audit-logs.md) - [Log streams](https://techdocs.akamai.com/cloud-computing/docs/streams.md) - [Create a stream](https://techdocs.akamai.com/cloud-computing/docs/copy-of-manage-streams-ga.md) - [Manage streams](https://techdocs.akamai.com/cloud-computing/docs/manage-streams.md) - [Log destinations](https://techdocs.akamai.com/cloud-computing/docs/destinations.md) - [Create a destination](https://techdocs.akamai.com/cloud-computing/docs/copy-of-manage-destinations-ga.md) - [Manage destinations](https://techdocs.akamai.com/cloud-computing/docs/manage-destinations.md) - [Protect logs in Object Storage](https://techdocs.akamai.com/cloud-computing/docs/protect-logs-in-object-storage.md) - [Log formats and content](https://techdocs.akamai.com/cloud-computing/docs/log-files.md) - [Events captured in configuration audit logs](https://techdocs.akamai.com/cloud-computing/docs/configuration-audit-log-events.md) - [Log delivery metrics](https://techdocs.akamai.com/cloud-computing/docs/log-delivery-metrics.md) - [Longview](https://techdocs.akamai.com/cloud-computing/docs/longview.md) - [Get started with Longview](https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-longview.md) - [View and manage Longview clients](https://techdocs.akamai.com/cloud-computing/docs/view-and-manage-longview-clients.md) - [System metrics in Longview](https://techdocs.akamai.com/cloud-computing/docs/understanding-longview-metrics.md) - [Capture Apache metrics with Longview](https://techdocs.akamai.com/cloud-computing/docs/capture-apache-metrics-with-linode-longview.md) - [Capture NGINX metrics with Longview](https://techdocs.akamai.com/cloud-computing/docs/capture-nginx-metrics-with-linode-longview.md) - [Capture MySQL metrics with Longview](https://techdocs.akamai.com/cloud-computing/docs/capture-mysql-metrics-with-linode-longview.md) - [Change Longview plan (upgrade to Pro)](https://techdocs.akamai.com/cloud-computing/docs/change-longview-plan-upgrade-to-pro.md) - [Troubleshooting Longview](https://techdocs.akamai.com/cloud-computing/docs/troubleshooting-linode-longview.md) - [Cloud Manager](https://techdocs.akamai.com/cloud-computing/docs/cloud-manager.md) - [Overview of Cloud Manager](https://techdocs.akamai.com/cloud-computing/docs/overview-of-cloud-manager.md) - [Events and activity feeds](https://techdocs.akamai.com/cloud-computing/docs/what-are-cloud-manager-events-and-activity-feeds.md) - [Tags and groups](https://techdocs.akamai.com/cloud-computing/docs/tags-and-groups.md) - [Search in Cloud Manager](https://techdocs.akamai.com/cloud-computing/docs/search-in-cloud-manager.md) - [Troubleshooting errors in Cloud Manager](https://techdocs.akamai.com/cloud-computing/docs/troubleshooting-cloud-manager-errors.md) - [Linode CLI](https://techdocs.akamai.com/cloud-computing/docs/cli-1.md) - [Get started](https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli.md) - [Administration commands](https://techdocs.akamai.com/cloud-computing/docs/administration-commands.md) - [Domains commands](https://techdocs.akamai.com/cloud-computing/docs/domains-commands.md) - [Linode instances commands](https://techdocs.akamai.com/cloud-computing/docs/linode-instances-commands.md) - [Linode interfaces](https://techdocs.akamai.com/cloud-computing/docs/linode-interfaces.md) - [LKE commands](https://techdocs.akamai.com/cloud-computing/docs/lke-commands.md) - [NodeBalancers commands](https://techdocs.akamai.com/cloud-computing/docs/nodebalancers-commands.md) - [Object Storage commands](https://techdocs.akamai.com/cloud-computing/docs/object-storage-commands.md) - [Support commands](https://techdocs.akamai.com/cloud-computing/docs/support-commands.md) - [Volumes commands](https://techdocs.akamai.com/cloud-computing/docs/volumes-commands.md) - [StackScripts](https://techdocs.akamai.com/cloud-computing/docs/stackscripts.md) - [Get started with StackScripts](https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-stackscripts.md) - [Create a StackScript](https://techdocs.akamai.com/cloud-computing/docs/create-a-stackscript.md) - [Deploy a Linode using a StackScript](https://techdocs.akamai.com/cloud-computing/docs/deploy-a-compute-instance-using-a-stackscript.md) - [Manage StackScripts](https://techdocs.akamai.com/cloud-computing/docs/manage-stackscripts.md) - [Write a custom script for use with StackScripts](https://techdocs.akamai.com/cloud-computing/docs/write-a-custom-script-for-use-with-stackscripts.md) - [Common use cases for StackScripts](https://techdocs.akamai.com/cloud-computing/docs/common-use-cases-for-stackscripts.md) - [Use an externally hosted deployment script](https://techdocs.akamai.com/cloud-computing/docs/use-an-externally-hosted-deployment-script.md) ## Changelog - [Jul 9, 2026 — LKE updates](https://techdocs.akamai.com/cloud-computing/changelog/jul-9-2026-lke-updates.md) - [Jul 7, 2026 — LKE Enterprise Kubernetes v1.34 support](https://techdocs.akamai.com/cloud-computing/changelog/jul-7-2026-lke-enterprise-kubernetes-v134-support.md) - [Jul 1, 2026 — Reserved public IPv4 addresses](https://techdocs.akamai.com/cloud-computing/changelog/jul-1-2026-reserved-public-ipv4-addresses.md) - [Jul 1, 2026 — New billing model for G8 Linodes, GPU Linodes, and additional IPv4](https://techdocs.akamai.com/cloud-computing/changelog/jul-1-2026-new-billing-model.md) - [Jul 1, 2026 — NVIDIA RTX PRO™ 6000 Blackwell 8-card GPU instances (BETA)](https://techdocs.akamai.com/cloud-computing/changelog/july-1-2026-nvidia-rtx-protm-6000-blackwell-8-card-gpu-instances-beta.md) # Akamai Developer Center Documentation > Find developer tools, resources, and sample code, and connect with the Akamai community. ## Guides - [Akamai Developer Center](https://techdocs.akamai.com/developer/docs/developer-center.md): Find developer tools, resources, and sample code, and connect with the Akamai community. - [EdgeGrid](https://techdocs.akamai.com/developer/docs/edgegrid.md) - [Connectors](https://techdocs.akamai.com/developer/docs/connectors.md) - [Akamai CLI](https://techdocs.akamai.com/developer/docs/cli.md) - [Postman](https://techdocs.akamai.com/developer/docs/postman.md) - [HTTPie](https://techdocs.akamai.com/developer/docs/httpie.md) - [Docker](https://techdocs.akamai.com/developer/docs/docker.md) - [Error response syntax](https://techdocs.akamai.com/developer/docs/error-responses.md) ## Recipes - [Authenticate API requests](https://techdocs.akamai.com/developer/recipes/authenticate-api-requests.md) # Akamai Direct Connect Documentation > Akamai's Direct Connect is a high performance network interconnection between your origin infrastructure and the Akamai Intelligent Edge Platform. Direct Connect lets you connect to the platform without using a third-party IP transit provider. It provides private connectivity between the platform and a router in your data center or colocation environment. ## Guides - [Welcome to Akamai Direct Connect](https://techdocs.akamai.com/direct-connect/docs/welcome-direct-connect.md) - [Network Architecture and Failover](https://techdocs.akamai.com/direct-connect/docs/deployments.md) - [Products supported for use with Direct Connect](https://techdocs.akamai.com/direct-connect/docs/interoperability.md) - [Supported locations](https://techdocs.akamai.com/direct-connect/docs/loc-supported.md) - [Hardware and software requirements](https://techdocs.akamai.com/direct-connect/docs/hardware-software-req.md) - [Specifications](https://techdocs.akamai.com/direct-connect/docs/specs.md) - [Routing policy](https://techdocs.akamai.com/direct-connect/docs/routing-policy.md) - [Configure Direct Connect](https://techdocs.akamai.com/direct-connect/docs/config-direct-connect.md) - [Cross connects](https://techdocs.akamai.com/direct-connect/docs/use-cross-connect.md) - [Sample configurations](https://techdocs.akamai.com/direct-connect/docs/sample-configs.md) - [Enable alert notifications](https://techdocs.akamai.com/direct-connect/docs/enable-alert-notif.md) ## Changelog - [Jul 1, 2025 — Prolexic support](https://techdocs.akamai.com/direct-connect/changelog/jul-1-2025-prolexic-support-1.md) - [Nov 23, 2023 — New UI launched](https://techdocs.akamai.com/direct-connect/changelog/nov-23-2023-new-ui-launched.md) - [Jan 31, 2023 — API Acceleration support](https://techdocs.akamai.com/direct-connect/changelog/jan-31-2023-api-acceleration-support.md) - [Nov 11, 2022 — Akamai Direct Connect 1.1](https://techdocs.akamai.com/direct-connect/changelog/nov-11-2022-akamai-direct-connect-11.md) - [Jul 30, 2021 — New Direct Connect documentation experience](https://techdocs.akamai.com/direct-connect/changelog/jul-27-2021-new-direct-connect-documentation-experience.md) # Akamai Functions Documentation > Akamai Functions uses Spin to run edge native applications on Akamai Cloud. As a globally distributed PaaS Akamai Functions offers: Fast and resilient hosting for Spin applications, no maintenance tasks for infrastructure, fast application execution and availability in multiple regions across the world, automatic distribution and availability in multiple regions, and a URL that persists across deployments. ## Guides - [Welcome to Akamai Functions (Limited availability)](https://techdocs.akamai.com/akamai-functions/docs/welcome.md) - [Quickstart](https://techdocs.akamai.com/akamai-functions/docs/quickstart.md) - [Manage accounts](https://techdocs.akamai.com/akamai-functions/docs/manage-accounts.md) - [Integrate with Property Manager](https://techdocs.akamai.com/akamai-functions/docs/integrate-with-property-manager.md) - [Stream data from Linode Object Store](https://techdocs.akamai.com/akamai-functions/docs/stream-data-from-linode-object-store.md) - [Query relational databases: MySQL](https://techdocs.akamai.com/akamai-functions/docs/query-relational-databases-mysql.md) - [Query relational databases: PostgreSQL](https://techdocs.akamai.com/akamai-functions/docs/query-relational-databases-postgresql.md) - [Build a Supabase cache proxy](https://techdocs.akamai.com/akamai-functions/docs/build-a-supabase-cache-proxy.md) - [Schedule tasks with cron jobs in Spin (Tech Preview)](https://techdocs.akamai.com/akamai-functions/docs/schedule-tasks-with-cron-jobs-in-spin.md) - [Use the Key Value store](https://techdocs.akamai.com/akamai-functions/docs/use-the-key-value-store.md) - [Link an application](https://techdocs.akamai.com/akamai-functions/docs/link-an-application.md) - [List and inspect your applications](https://techdocs.akamai.com/akamai-functions/docs/list-and-inspect-your-applications.md) - [Update an application](https://techdocs.akamai.com/akamai-functions/docs/update-an-application.md) - [Delete an application](https://techdocs.akamai.com/akamai-functions/docs/delete-an-application.md) - [Deploy and specify application variables](https://techdocs.akamai.com/akamai-functions/docs/deploy-app-variables.md) - [Deploy using GitHub actions](https://techdocs.akamai.com/akamai-functions/docs/deploy-using-github-actions.md) - [aka command reference](https://techdocs.akamai.com/akamai-functions/docs/aka-command-reference.md) - [WebAssembly language support matrix](https://techdocs.akamai.com/akamai-functions/docs/webassembly-language-support-matrix.md) - [HTTP trigger reference](https://techdocs.akamai.com/akamai-functions/docs/http-trigger-reference.md) - [WebAssembly standards](https://techdocs.akamai.com/akamai-functions/docs/related-standards.md) - [FAQ](https://techdocs.akamai.com/akamai-functions/docs/faq.md) - [Application logs](https://techdocs.akamai.com/akamai-functions/docs/application-logs.md) - [Quotas and limits](https://techdocs.akamai.com/akamai-functions/docs/quotas-and-limits.md) ## Changelog - [Mar 20, 2026 — Spin aka v0.7.0 updates](https://techdocs.akamai.com/akamai-functions/changelog/mar-20-2026-spin-aka-v070-updates.md) - [Dec 5, 2025 — Spin aka v0.6.0 updates](https://techdocs.akamai.com/akamai-functions/changelog/dec-5-2025-spin-aka-v060-updates.md) - [Sept 16, 2025 — Spin aka v0.5.0 updates](https://techdocs.akamai.com/akamai-functions/changelog/sept-16-2025-spin-aka-v050-updates.md) - [Aug 26, 2025 — Spin aka v0.4.4 updates](https://techdocs.akamai.com/akamai-functions/changelog/aug-26-2025-spin-aka-v044-updates.md) - [Aug 7, 2025 — Spin aka v0.4.3 updates](https://techdocs.akamai.com/akamai-functions/changelog/aug-7-2025-spin-aka-v043-updates.md) # Akamai MFA Documentation > Akamai MFA is a workforce MFA service that enables enterprises to provide additional security to the existing identity validation mechanisms for users’ authentication and access to cloud, on-premise, web-based, SaaS, and IaaS applications. ## Guides - [Welcome to Akamai MFA](https://techdocs.akamai.com/mfa/docs/welcome-mfa.md) - [Set up Akamai MFA](https://techdocs.akamai.com/mfa/docs/set-up-mfa.md) - [Sync your directory services with Akamai MFA](https://techdocs.akamai.com/mfa/docs/sync-directory-mfa.md) - [Add integrations](https://techdocs.akamai.com/mfa/docs/add-integrations.md) - [Define policies](https://techdocs.akamai.com/mfa/docs/define-policies.md) - [Enable users to self-enroll](https://techdocs.akamai.com/mfa/docs/enable-self-enroll.md) - [Deploy your installation](https://techdocs.akamai.com/mfa/docs/deploy-installation.md) - [Manage Akamai MFA](https://techdocs.akamai.com/mfa/docs/manage-mfa.md) - [Access Akamai MFA](https://techdocs.akamai.com/mfa/docs/access-mfa.md) - [Role-based access controls](https://techdocs.akamai.com/mfa/docs/role-based-access-controls.md) - [View the MFA Dashboard](https://techdocs.akamai.com/mfa/docs/view-mfa-dashboard.md) - [Provision and deprovision users](https://techdocs.akamai.com/mfa/docs/prov-deprov-users.md) - [Add a user account manually](https://techdocs.akamai.com/mfa/docs/add-user-manually.md) - [Upload a csv file](https://techdocs.akamai.com/mfa/docs/upload-csv-file.md) - [Provision users from IDPs using SCIM](https://techdocs.akamai.com/mfa/docs/generic-scim-provisioning.md) - [Provision users from the AD or LDAP services](https://techdocs.akamai.com/mfa/docs/provision-ad-ldap.md) - [Provision users from EAA](https://techdocs.akamai.com/mfa/docs/provi-users-eaa.md) - [Provision users from Entra ID using SCIM](https://techdocs.akamai.com/mfa/docs/prov-users-azure-scim.md) - [Provision users from Okta using SCIM](https://techdocs.akamai.com/mfa/docs/prov-users-okta-scim.md) - [Enroll new users](https://techdocs.akamai.com/mfa/docs/enroll-new-users.md) - [Send bulk emails to users](https://techdocs.akamai.com/mfa/docs/bulk-emails-users.md) - [Send bulk emails to group members](https://techdocs.akamai.com/mfa/docs/bulk-emails-grp.md) - [Delete users and groups manually](https://techdocs.akamai.com/mfa/docs/delete-manually.md) - [Support users in China](https://techdocs.akamai.com/mfa/docs/support-china-users.md) - [Manage the enrollment emails](https://techdocs.akamai.com/mfa/docs/manage-enrollment-emails.md) - [View the enrollment email details](https://techdocs.akamai.com/mfa/docs/view-email-details.md) - [Customize the enrollment email](https://techdocs.akamai.com/mfa/docs/customize-enrollment-email.md) - [Manage users and devices](https://techdocs.akamai.com/mfa/docs/manage-users-devices.md) - [View users in the list](https://techdocs.akamai.com/mfa/docs/view-users-list.md) - [User statuses](https://techdocs.akamai.com/mfa/docs/user-statuses.md) - [Search and filter users in the list](https://techdocs.akamai.com/mfa/docs/search-filter-users.md) - [View user details](https://techdocs.akamai.com/mfa/docs/view-user-details.md) - [Update a user account manually](https://techdocs.akamai.com/mfa/docs/update-user-manually.md) - [Add and remove a user from a group](https://techdocs.akamai.com/mfa/docs/add-rm-user-grp.md) - [Enable and disable a user account](https://techdocs.akamai.com/mfa/docs/enable-and-disable-a-user-account.md) - [View devices](https://techdocs.akamai.com/mfa/docs/view-devices.md) - [Device statuses](https://techdocs.akamai.com/mfa/docs/device-statuses.md) - [Enroll a device for a user](https://techdocs.akamai.com/mfa/docs/enroll-a-user-directly.md) - [Verify a user](https://techdocs.akamai.com/mfa/docs/verify-a-user.md) - [Manage hardware tokens](https://techdocs.akamai.com/mfa/docs/manage-hardware-tokens.md) - [Assign a hardware token to a user](https://techdocs.akamai.com/mfa/docs/assign-hardware-token.md) - [Unassign a hardware token from a user](https://techdocs.akamai.com/mfa/docs/unassign-hardware-token.md) - [Resync a hardware token](https://techdocs.akamai.com/mfa/docs/resync-hardware-tokens.md) - [Enable, disable, and delete a device](https://techdocs.akamai.com/mfa/docs/activate-deactivate-device.md) - [Generate a bypass code](https://techdocs.akamai.com/mfa/docs/generate-bypass-code.md) - [Manage locked-out user accounts](https://techdocs.akamai.com/mfa/docs/manage-locked-out-user.md) - [Customize the mobile app branding](https://techdocs.akamai.com/mfa/docs/customize-mobile-app.md) - [Manage groups](https://techdocs.akamai.com/mfa/docs/manage-group.md) - [View groups in the list](https://techdocs.akamai.com/mfa/docs/view-groups-in-the-list.md) - [Search and filter group list](https://techdocs.akamai.com/mfa/docs/search-filter-group.md) - [View group members](https://techdocs.akamai.com/mfa/docs/view-group-members.md) - [Add a group account manually](https://techdocs.akamai.com/mfa/docs/add-group-manually.md) - [Update a group account manually](https://techdocs.akamai.com/mfa/docs/update-group-manually.md) - [Manage integrations](https://techdocs.akamai.com/mfa/docs/manage-integrations.md) - [Apply the username normalization](https://techdocs.akamai.com/mfa/docs/username-normalization.md) - [EAA identity provider](https://techdocs.akamai.com/mfa/docs/eaa-idp.md) - [Microsoft Active Directory Federation Services](https://techdocs.akamai.com/mfa/docs/adfs.md) - [Microsoft Entra ID External Authentication Methods (EAM)](https://techdocs.akamai.com/mfa/docs/entra-id-eam.md) - [Okta](https://techdocs.akamai.com/mfa/docs/okta.md) - [Okta passwordless login](https://techdocs.akamai.com/mfa/docs/passwordless-login-okta.md) - [Shibboleth](https://techdocs.akamai.com/mfa/docs/shibboleth.md) - [Splunk adapter](https://techdocs.akamai.com/mfa/docs/splunk-adapter.md) - [Unix PAM](https://techdocs.akamai.com/mfa/docs/unix-pam.md) - [Krypton akr FIDO2 SSH Agent (beta)](https://techdocs.akamai.com/mfa/docs/akr-fido2-ssh-agent.md) - [Windows Logon](https://techdocs.akamai.com/mfa/docs/windows-logon-plugin.md) - [Demo integration](https://techdocs.akamai.com/mfa/docs/demo-integration.md) - [SAML integration](https://techdocs.akamai.com/mfa/docs/saml.md) - [PingFederate](https://techdocs.akamai.com/mfa/docs/pingfederate-integration.md) - [Keycloak](https://techdocs.akamai.com/mfa/docs/keycloak-integration.md) - [PingOne DaVinci](https://techdocs.akamai.com/mfa/docs/ping-davinci.md) - [PacketFence Gateway](https://techdocs.akamai.com/mfa/docs/pf-gateway.md) - [Prerequisites](https://techdocs.akamai.com/mfa/docs/prereq.md) - [Add PacketFence Gateway integration](https://techdocs.akamai.com/mfa/docs/add-pf-integr.md) - [VPN server configured as a Radius client only](https://techdocs.akamai.com/mfa/docs/vpn-radius-client.md) - [VPN server configured as a Radius client only that supports sending passcode via Radius](https://techdocs.akamai.com/mfa/docs/vpn-radius-client-passcode.md) - [VPN server that allows the user’s interaction with the VPN client](https://techdocs.akamai.com/mfa/docs/vpn-allowing-interaction.md) - [VPN server that supports an external login page or can use the PacketFence captive portal](https://techdocs.akamai.com/mfa/docs/vpn-captive-portal.md) - [VPN Configuration Guide](https://techdocs.akamai.com/mfa/docs/vpn-config-guide.md) - [Troubleshoot PacketFence integration issues](https://techdocs.akamai.com/mfa/docs/troubleshoot-pf.md) - [Manage policies](https://techdocs.akamai.com/mfa/docs/manage-policies.md) - [Configure policy for an unenrolled and enrolled user](https://techdocs.akamai.com/mfa/docs/new-existing-user-policy.md) - [Configure your device posture policy](https://techdocs.akamai.com/mfa/docs/device-posture-policy.md) - [Configure your lockout policy](https://techdocs.akamai.com/mfa/docs/lockout-policy.md) - [Edit the global policy](https://techdocs.akamai.com/mfa/docs/edit-global-policy.md) - [Configure custom policies](https://techdocs.akamai.com/mfa/docs/config-custom-policies.md) - [Associate policies](https://techdocs.akamai.com/mfa/docs/associate-policies.md) - [Edit a policy association](https://techdocs.akamai.com/mfa/docs/dissociate-policies.md) - [Allowed authentication methods](https://techdocs.akamai.com/mfa/docs/allowed-auth-methods.md) - [Configure your offline authentication policy](https://techdocs.akamai.com/mfa/docs/offline-authentication-policy.md) - [Configure your remembered devices policy](https://techdocs.akamai.com/mfa/docs/remembered-devices-policy.md) - [Deploy configuration changes](https://techdocs.akamai.com/mfa/docs/deploy-config-changes.md) - [View the Deployments History](https://techdocs.akamai.com/mfa/docs/view-deployments-history.md) - [Deploy Pending Changes](https://techdocs.akamai.com/mfa/docs/deploy-pending-changes.md) - [Manage reports](https://techdocs.akamai.com/mfa/docs/manage-reports.md) - [Generate the Authentication events report](https://techdocs.akamai.com/mfa/docs/generate-auth-events.md) - [Troubleshoot authentication issues](https://techdocs.akamai.com/mfa/docs/troubleshoot-auth-events.md) - [Use Akamai MFA](https://techdocs.akamai.com/mfa/docs/use-mfa.md) - [Self-enroll in Akamai MFA](https://techdocs.akamai.com/mfa/docs/self-enroll-mfa.md) - [Self-enroll your smartphone or tablet](https://techdocs.akamai.com/mfa/docs/self-enroll-smartphone.md) - [Self-enroll your platform authenticator](https://techdocs.akamai.com/mfa/docs/self-enroll-your-platform-authenticator.md) - [Self-enroll your security key](https://techdocs.akamai.com/mfa/docs/self-enroll-security-key.md) - [Self-enroll your passkey](https://techdocs.akamai.com/mfa/docs/self-enroll-your-passkey.md) - [Self-enroll your WebAuthn credential](https://techdocs.akamai.com/mfa/docs/self-enroll-your-webauthn-credential.md) - [Self-enroll your third-party authenticator app](https://techdocs.akamai.com/mfa/docs/enroll-third-party-otp.md) - [Self-enroll your phone number](https://techdocs.akamai.com/mfa/docs/self-enroll-phone.md) - [Authenticate with Akamai MFA](https://techdocs.akamai.com/mfa/docs/auth-mfa.md) - [The authentication prompt](https://techdocs.akamai.com/mfa/docs/auth-prompt.md) - [Use a push notification](https://techdocs.akamai.com/mfa/docs/use-push-notif.md) - [Use your security key](https://techdocs.akamai.com/mfa/docs/use-security-key.md) - [Use a platform authenticator](https://techdocs.akamai.com/mfa/docs/use-a-platform-authenticator.md) - [Use a passkey](https://techdocs.akamai.com/mfa/docs/use-a-passkey.md) - [Use a WebAuthn credential](https://techdocs.akamai.com/mfa/docs/use-a-webauthn-credential.md) - [Use a push MFA TOTP](https://techdocs.akamai.com/mfa/docs/use-push-totp.md) - [Use a magic link (via SMS)](https://techdocs.akamai.com/mfa/docs/use-clientless-push.md) - [Use a phone call OTP](https://techdocs.akamai.com/mfa/docs/use-phone-call.md) - [Use hardware token](https://techdocs.akamai.com/mfa/docs/use-hardware-token.md) - [Use an email or SMS OTP](https://techdocs.akamai.com/mfa/docs/use-email-sms-otp.md) - [Use a bypass code](https://techdocs.akamai.com/mfa/docs/use-bypass-code.md) - [Use your third-party OTP device](https://techdocs.akamai.com/mfa/docs/use-third-party-otp.md) - [Use MFA for Windows logins](https://techdocs.akamai.com/mfa/docs/use-mfa-rdp-logins.md) - [Use MFA for SSH logins](https://techdocs.akamai.com/mfa/docs/use-mfa-ssh-logins.md) - [Manage your devices](https://techdocs.akamai.com/mfa/docs/manage-devices.md) - [Enroll a new device](https://techdocs.akamai.com/mfa/docs/register-new-device.md) - [Delete an enrolled device](https://techdocs.akamai.com/mfa/docs/delete-enrolled-device.md) - [Enable automatic challenge](https://techdocs.akamai.com/mfa/docs/enable-auto-challenge.md) - [Display the installation help page](https://techdocs.akamai.com/mfa/docs/display-install-help-page.md) - [Remove your account from the mobile app](https://techdocs.akamai.com/mfa/docs/rm-account-mfa-app.md) - [Manage your Phone Security Key and browser pairing](https://techdocs.akamai.com/mfa/docs/manage-your-phone-security-key-browser-pairing.md) - [Akamai MFA Splunk app](https://techdocs.akamai.com/mfa/docs/splunk-app.md) ## API Reference - [Akamai MFA API](https://techdocs.akamai.com/mfa/reference/api.md) - [API summary](https://techdocs.akamai.com/mfa/reference/api-summary.md) - [Get started](https://techdocs.akamai.com/mfa/reference/get-started.md) - [API concepts](https://techdocs.akamai.com/mfa/reference/mfa-concepts.md) - [Errors](https://techdocs.akamai.com/mfa/reference/errors.md) - [400](https://techdocs.akamai.com/mfa/reference/400.md) - [401](https://techdocs.akamai.com/mfa/reference/401.md) - [403](https://techdocs.akamai.com/mfa/reference/403.md) - [404](https://techdocs.akamai.com/mfa/reference/404.md) - [500](https://techdocs.akamai.com/mfa/reference/500.md) - [Send enrollment email](https://techdocs.akamai.com/mfa/reference/post-send-enrollment-email.md): Send enrollment email to a set of new users inviting them to Akamai MFA. This operation provides users with unique links to enroll and activate authentication devices in Akamai MFA. - [Add a user](https://techdocs.akamai.com/mfa/reference/post-user.md): Create a new user. - [List users](https://techdocs.akamai.com/mfa/reference/get-users.md): List user accounts configured in Akamai MFA, optionally filtered and paginated. - [Get a user](https://techdocs.akamai.com/mfa/reference/get-user.md): Get details about a specific user account, including the `userId`, `status`, and `username`. It also lists the `alias` information and `groups` that the user belongs to. - [Update a user](https://techdocs.akamai.com/mfa/reference/put-user.md): Modify a user's basic information. To add an alias or assign a group to a user, run the [Add an alias to a user](ref:post-alias-to-user) and [Assign groups](ref:post-assign-groups-to-user) operations. - [Delete a user](https://techdocs.akamai.com/mfa/reference/delete-user.md): Permanently delete a specific user account. You can delete any active user account from your Akamai MFA service. For manually added users, deleting means permanently removing the user accounts together with any enrolled authentication device. User accounts that still exist in the external source directory reappear after the next synchronization. - [Add an alias to a user](https://techdocs.akamai.com/mfa/reference/post-alias-to-user.md): Add an alternative username for a user. - [Delete an alias assigned to a user](https://techdocs.akamai.com/mfa/reference/delete-user-alias.md): Permanently delete a user's alias. - [Assign groups](https://techdocs.akamai.com/mfa/reference/post-assign-groups-to-user.md): Assign a set of groups to a user account. With this operation you can modify the users' group assignment when their role in the organization changes. After you modify the users' group membership, you can manage their access to different integrations at group level. - [Assign policies](https://techdocs.akamai.com/mfa/reference/post-assign-policies-to-user.md): Assign a set of policies to a user account. With this operation you can modify the users' access privileges when their role in the organization changes. After you modify the users' policy assignation, the users need to meet the requirements of a specific authentication policy before they can access a protected application. - [Create a bypass code](https://techdocs.akamai.com/mfa/reference/post-bypass-code.md): Generate a new bypass code for a specific user account. - [List bypass codes](https://techdocs.akamai.com/mfa/reference/get-bypass-codes.md): List all the bypass codes generated for a specific user account. - [List the user's devices](https://techdocs.akamai.com/mfa/reference/get-user-devices.md): List all the user's authentication devices. - [Assign a hardware token](https://techdocs.akamai.com/mfa/reference/post-assign-hardware-token.md): Assign a hardware token to a specific user account. To assign a hardware token, you need the token's serial number. You can also unassign and reassign a hardware token from one active user account to another. A hardware token assigned to a user account gets automatically unassigned when the account is deleted, and returns to the pool of available tokens that you can assign to another user. - [Disable a device](https://techdocs.akamai.com/mfa/reference/post-disable-user-device.md): Deactivate the user's authentication device. - [Enable a device](https://techdocs.akamai.com/mfa/reference/post-enable-user-device.md): Activate the user's authentication device. - [Add a group](https://techdocs.akamai.com/mfa/reference/post-group.md): Create a new group. - [List groups](https://techdocs.akamai.com/mfa/reference/get-groups.md): List groups configured in Akamai MFA, optionally filtered and paginated. - [Get a group](https://techdocs.akamai.com/mfa/reference/get-group.md): Retrieve a group's details. - [Delete a group](https://techdocs.akamai.com/mfa/reference/delete-group.md): Permanently delete a group. - [Add a user to a group](https://techdocs.akamai.com/mfa/reference/post-user-to-group.md): Add a user to a group. - [Remove a user from a group](https://techdocs.akamai.com/mfa/reference/delete-user-from-group.md): Remove a user from a group. ## Recipes - [Assign a hardware token](https://techdocs.akamai.com/mfa/recipes/assign-a-hardware-token.md) - [Assign groups](https://techdocs.akamai.com/mfa/recipes/assign-groups.md) - [Assign policies](https://techdocs.akamai.com/mfa/recipes/assign-policies.md) - [Create a bypass code](https://techdocs.akamai.com/mfa/recipes/create-a-bypass-code.md) - [Delete a user](https://techdocs.akamai.com/mfa/recipes/delete-a-user.md) - [Disable a device](https://techdocs.akamai.com/mfa/recipes/disable-a-device.md) - [Enable a device](https://techdocs.akamai.com/mfa/recipes/enable-a-device.md) - [Get a bypass code](https://techdocs.akamai.com/mfa/recipes/get-a-bypass-code.md) - [Get a user](https://techdocs.akamai.com/mfa/recipes/get-a-user.md) - [List bypass codes](https://techdocs.akamai.com/mfa/recipes/list-bypass-codes.md) - [List the user's devices](https://techdocs.akamai.com/mfa/recipes/list-the-users-devices.md) - [List users](https://techdocs.akamai.com/mfa/recipes/list-users.md) - [Send enrollment email](https://techdocs.akamai.com/mfa/recipes/send-enrollment-email.md) ## Changelog - [May 15, 2026 — Enterprise Center updates](https://techdocs.akamai.com/mfa/changelog/may-15-2026-enterprise-center-updates.md) - [Apr 29, 2026 — Enterprise Center Legacy UI End-of-Life](https://techdocs.akamai.com/mfa/changelog/apr-29-2026-enterprise-center-legacy-ui-end-of-life.md) - [Apr 8, 2026 — Akamai MFA updates](https://techdocs.akamai.com/mfa/changelog/apr-8-2026-akamai-mfa-updates.md) - [Mar 5, 2026 — Verify user identity](https://techdocs.akamai.com/mfa/changelog/mar-5-2026-verify-user-identity.md) - [Feb 13, 2026 — Hardware token resync](https://techdocs.akamai.com/mfa/changelog/feb-13-2026-hardware-token-resync.md) # Akamai MFA OIDC API Documentation > Akamai MFA OIDC API lets you integrate multi-factor authentication (MFA) into OpenID Connect (OIDC) authentication flows using Pushed Authorization Requests (PAR). ## API Reference - [Akamai MFA OIDC API](https://techdocs.akamai.com/mfa-oidc/reference/api.md) - [API summary](https://techdocs.akamai.com/mfa-oidc/reference/api-summary.md) - [Get started](https://techdocs.akamai.com/mfa-oidc/reference/get-started.md) - [API concepts](https://techdocs.akamai.com/mfa-oidc/reference/api-concepts.md) - [API workflow](https://techdocs.akamai.com/mfa-oidc/reference/api-workflow.md) - [Errors](https://techdocs.akamai.com/mfa-oidc/reference/errors.md) - [400](https://techdocs.akamai.com/mfa-oidc/reference/400.md): Bad Request - [401](https://techdocs.akamai.com/mfa-oidc/reference/401.md): Unauthorized - [403](https://techdocs.akamai.com/mfa-oidc/reference/403.md): Forbidden - [404](https://techdocs.akamai.com/mfa-oidc/reference/404.md): Not Found - [415](https://techdocs.akamai.com/mfa-oidc/reference/415.md): Unsupported Media Type - [500](https://techdocs.akamai.com/mfa-oidc/reference/500.md) - [Get an authorization code](https://techdocs.akamai.com/mfa-oidc/reference/get-authorize.md): This operation authenticates and authorizes the user. You need to make this request from the browser. - [Submit an authorization request](https://techdocs.akamai.com/mfa-oidc/reference/post-par.md): This operation returns a short-lived, one-time use reference to the stored authorization request. - [Create an ID token](https://techdocs.akamai.com/mfa-oidc/reference/post-token.md): This operation exchanges an [authorization code](ref:get-authorize) for ID token. # Alerts Documentation > Akamai's Alerts application is a monitoring tool that both analyzes historical audience metrics and projects the expected traffic. Using intelligent algorithms, this service compares projected traffic with actual traffic in real time, and includes static alerts based on thresholds you set. It can trigger adaptive web alerts when current audience metrics goes above or below projected traffic. It does this by taking into consideration accurate traffic patterns modeled on historical data rather than on static thresholds. ## Guides - [Welcome to Alerts](https://techdocs.akamai.com/alerts-app/docs/welcome-alerts.md) - [Notifications](https://techdocs.akamai.com/alerts-app/docs/notif.md) - [Available alerts](https://techdocs.akamai.com/alerts-app/docs/available-alerts.md) - [24x7 Stream Ingest Stopped](https://techdocs.akamai.com/alerts-app/docs/24x7-stream-ingest-stopped.md) - [24x7 Stream Stale playlist detected](https://techdocs.akamai.com/alerts-app/docs/24x7-stream-stale-playlist-detected.md) - [Adaptive](https://techdocs.akamai.com/alerts-app/docs/adaptive.md) - [All Customer Servers for Property Down](https://techdocs.akamai.com/alerts-app/docs/customer-servers-prop-down.md) - [API Gateway throttling limit alert](https://techdocs.akamai.com/alerts-app/docs/api-gateway-throttling-limit-alert.md) - [Authorities for DNSSEC Zone do not point to Akamai](https://techdocs.akamai.com/alerts-app/docs/authorities-dnssec-zone-point-akamai.md) - [Authorities incompatible with Sign&Serve DNSSEC](https://techdocs.akamai.com/alerts-app/docs/authorities-incompatible-sign-serve-dnssec.md) - [Average Latency for a specific stream bitrate](https://techdocs.akamai.com/alerts-app/docs/average-latency-specific-stream-bitrate.md) - [Average Latency for a Stream](https://techdocs.akamai.com/alerts-app/docs/average-latency-stream.md) - [BGP Down](https://techdocs.akamai.com/alerts-app/docs/bgp-down.md) - [Bitrate deviation for a specific stream bitrate](https://techdocs.akamai.com/alerts-app/docs/bitrate-deviation-specific-stream-bitrate.md) - [BOCC: High Error Rate (Multicaster-SMM) (StreamId)](https://techdocs.akamai.com/alerts-app/docs/bocc-high-err-rate-multicaster-smm-streamid.md) - [Certificate's domain is blocked](https://techdocs.akamai.com/alerts-app/docs/cert-domain-blocked.md) - [Control Center Event](https://techdocs.akamai.com/alerts-app/docs/cc-event.md) - [Customer Datacenter Down](https://techdocs.akamai.com/alerts-app/docs/customer-datacenter-down.md) - [Customer Server IP in Multiple Regions](https://techdocs.akamai.com/alerts-app/docs/customer-server-ip-multiple-regions.md) - [Customer Server Removed from Rotation](https://techdocs.akamai.com/alerts-app/docs/customer-server-rmd-rotation.md) - [DataStream - Upload Failures](https://techdocs.akamai.com/alerts-app/docs/datastream-upload-failures.md) - [Directory containing too many files and subdirectories](https://techdocs.akamai.com/alerts-app/docs/dir-containing-many-files-sdirs.md) - [DNS does not contain an authorized certificate authority](https://techdocs.akamai.com/alerts-app/docs/dns-not-authorized-cert-authority.md) - [Domain validation failed](https://techdocs.akamai.com/alerts-app/docs/domain-validation-failed.md) - [Download Time](https://techdocs.akamai.com/alerts-app/docs/dl-time.md) - [DS record points to old DNSKEY record](https://techdocs.akamai.com/alerts-app/docs/ds-record-points-old-dnskey-record.md) - [DS record points to wrong DNSKEY record](https://techdocs.akamai.com/alerts-app/docs/ds-record-points-wrong-dnskey-record.md) - [Dynamic Flash (Ingest) Stream is Unavailable](https://techdocs.akamai.com/alerts-app/docs/dynamic-flash-ingest-stream-unavailable.md) - [Edge Errors -- Content Delivery (HTTP 4xx and 5xx errors)](https://techdocs.akamai.com/alerts-app/docs/edge-err-content-deliv-http-4xx-5xx-err.md) - [Edge Errors -- HLS](https://techdocs.akamai.com/alerts-app/docs/edge-err-hls.md) - [Edge High MB Delivered](https://techdocs.akamai.com/alerts-app/docs/edge-high-mb-delivered.md) - [Edge HTTP Status Code Errors -- Content Delivery](https://techdocs.akamai.com/alerts-app/docs/edge-http-status-code-err-content-deliv.md) - [Edge HTTP Status Code Errors -- HLS](https://techdocs.akamai.com/alerts-app/docs/edge-http-status-code-err-hls.md) - [Expired Default certificate](https://techdocs.akamai.com/alerts-app/docs/expired-default-certificate.md) - [Expired Default certificate removal](https://techdocs.akamai.com/alerts-app/docs/expired-default-certificate-removal.md) - [Failed Zonetransfer (Critical)](https://techdocs.akamai.com/alerts-app/docs/fail-zonetransfer-critical.md) - [High Concurrent Connections](https://techdocs.akamai.com/alerts-app/docs/high-concurrent-connections.md) - [High Concurrent Sessions](https://techdocs.akamai.com/alerts-app/docs/high-concurrent-sessions.md) - [High Concurrent Streams - FLASH](https://techdocs.akamai.com/alerts-app/docs/high-concurrent-streams-flash.md) - [High Disk Usage - NetStorage](https://techdocs.akamai.com/alerts-app/docs/high-disk-usage-ns.md) - [High Edge Hits](https://techdocs.akamai.com/alerts-app/docs/high-edge-hits.md) - [High Edge Hits -- Content Delivery](https://techdocs.akamai.com/alerts-app/docs/high-edge-hits-content-deliv.md) - [High number of NXDOMAIN responses](https://techdocs.akamai.com/alerts-app/docs/high-number-nxdomain-responses.md) - [High Origin Hits](https://techdocs.akamai.com/alerts-app/docs/high-origin-hits.md) - [High Page View Usage](https://techdocs.akamai.com/alerts-app/docs/high-page-view-usage.md) - [High Storage Read Operations](https://techdocs.akamai.com/alerts-app/docs/high-storage-read-op.md) - [High Storage Write Operations](https://techdocs.akamai.com/alerts-app/docs/high-storage-write-op.md) - [High Streaming Traffic - FLASH](https://techdocs.akamai.com/alerts-app/docs/high-streaming-traffic-flash.md) - [High Traffic - DNS](https://techdocs.akamai.com/alerts-app/docs/high-traffic-dns.md) - [High Traffic -- Content Delivery](https://techdocs.akamai.com/alerts-app/docs/high-traffic-content-deliv.md) - [High Traffic -- HLS](https://techdocs.akamai.com/alerts-app/docs/high-traffic-hls.md) - [High Traffic -- IPA/SXL](https://techdocs.akamai.com/alerts-app/docs/high-traffic-ipa-sxl.md) - [High Traffic Origin - Content Delivery](https://techdocs.akamai.com/alerts-app/docs/high-traffic-origin-content-deliv.md) - [High Traffic Origin -- HLS](https://techdocs.akamai.com/alerts-app/docs/high-traffic-origin-hls.md) - [High Usage -- Streaming](https://techdocs.akamai.com/alerts-app/docs/high-usage-streaming.md) - [High Utilization](https://techdocs.akamai.com/alerts-app/docs/high-utilization.md) - [High Volume](https://techdocs.akamai.com/alerts-app/docs/high-volume.md) - [High Volume -- HLS](https://techdocs.akamai.com/alerts-app/docs/high-volume-hls.md) - [Incomplete Downloads -- Content Delivery](https://techdocs.akamai.com/alerts-app/docs/incomplete-dls-content-deliv.md) - [Incomplete Downloads -- HLS](https://techdocs.akamai.com/alerts-app/docs/incomplete-dls-hls.md) - [Ingest HTTP Upload Errors](https://techdocs.akamai.com/alerts-app/docs/ingest-http-upload-err.md) - [Input Packet Loss for a Stream](https://techdocs.akamai.com/alerts-app/docs/input-packet-loss-stream.md) - [Input Packet Loss for a stream bitrate](https://techdocs.akamai.com/alerts-app/docs/input-packet-loss-stream-bitrate.md) - [Interface errors](https://techdocs.akamai.com/alerts-app/docs/itf-err.md) - [Large Amount of MCDN Traffic Delivered from Akamai Intelligent Platform (AIP) - reported by maprule](https://techdocs.akamai.com/alerts-app/docs/large-amount-mcdn-traffic-delivered-akamai-intelligent-platform-aip-rpted-maprule.md) - [Link Down](https://techdocs.akamai.com/alerts-app/docs/link-down.md) - [Load Object File Invalid or Cannot be Fetched](https://techdocs.akamai.com/alerts-app/docs/load-object-file-invalid-cannot-fetched.md) - [Load Object File is Stale](https://techdocs.akamai.com/alerts-app/docs/load-object-file-stale.md) - [Loss of a specific stream bitrate](https://techdocs.akamai.com/alerts-app/docs/loss-specific-stream-bitrate.md) - [Low cache offload in MCDN edge cache tier - reported by cluster](https://techdocs.akamai.com/alerts-app/docs/low-cache-offload-mcdn-edge-cache-tier-rpted-cluster.md) - [Low cache offload in MCDN edge cache tier - reported by maprule](https://techdocs.akamai.com/alerts-app/docs/low-cache-offload-mcdn-edge-cache-tier-rpted-maprule.md) - [Low cache offload in MCDN grandparent cache tier - reported by cluster](https://techdocs.akamai.com/alerts-app/docs/low-cache-offload-mcdn-grandparent-cache-tier-rpted-cluster.md) - [Low cache offload in MCDN grandparent cache tier - reported by maprule](https://techdocs.akamai.com/alerts-app/docs/low-cache-offload-mcdn-grandparent-cache-tier-rpted-maprule.md) - [Low cache offload in MCDN parent cache tier - reported by cluster](https://techdocs.akamai.com/alerts-app/docs/low-cache-offload-mcdn-parent-cache-tier-rpted-cluster.md) - [Low cache offload in MCDN parent cache tier - reported by maprule](https://techdocs.akamai.com/alerts-app/docs/low-cache-offload-mcdn-parent-cache-tier-rpted-maprule.md) - [Low Offload Hits](https://techdocs.akamai.com/alerts-app/docs/low-offload-hits.md) - [Low Offload Traffic](https://techdocs.akamai.com/alerts-app/docs/low-offload-traffic.md) - [Low Streaming Traffic - FLASH](https://techdocs.akamai.com/alerts-app/docs/low-streaming-traffic-flash.md) - [Low Traffic -- Content Delivery](https://techdocs.akamai.com/alerts-app/docs/low-traffic-content-deliv.md) - [No DS record in parent zone](https://techdocs.akamai.com/alerts-app/docs/no-ds-record-parent-zone.md) - [Object Caching - 403+'l': File Too Large](https://techdocs.akamai.com/alerts-app/docs/object-caching-403l-file-too-large.md) - [Object Caching - 415: HTML Content Denied](https://techdocs.akamai.com/alerts-app/docs/object-caching-415-html-content-denied.md) - [Origin Access Denied (HTTP 401 and 403 errors)](https://techdocs.akamai.com/alerts-app/docs/origin-access-denied-http-401-403-err.md) - [Origin Connection Failure](https://techdocs.akamai.com/alerts-app/docs/origin-connection-failure.md) - [Origin DNS Failure](https://techdocs.akamai.com/alerts-app/docs/origin-dns-failure.md) - [Origin HTTP Status Code](https://techdocs.akamai.com/alerts-app/docs/origin-http-status-code.md) - [Origin Object Not Found (HTTP 404 errors)](https://techdocs.akamai.com/alerts-app/docs/origin-object-found-http-404-err.md) - [Origin Read Error](https://techdocs.akamai.com/alerts-app/docs/origin-read-err.md) - [Origin Server Failure (HTTP 5xx errors)](https://techdocs.akamai.com/alerts-app/docs/origin-server-failure-http-5xx-err.md) - [Origin SSL Transaction Failure](https://techdocs.akamai.com/alerts-app/docs/origin-ssl-transaction-failure.md) - [Origin Threshold Alert (IPA)](https://techdocs.akamai.com/alerts-app/docs/origin-threshold-alert-ipa.md) - [Page Failure](https://techdocs.akamai.com/alerts-app/docs/page-failure.md) - [Page Validation Failure](https://techdocs.akamai.com/alerts-app/docs/page-val-failure.md) - [SaaS Application Request-to-User Ratio per Contract](https://techdocs.akamai.com/alerts-app/docs/saas-app-req-user-ratio-per-contract.md) - [SaaS Application Request-to-User Ratio per CP Code](https://techdocs.akamai.com/alerts-app/docs/saas-app-req-user-ratio-per-cp-code.md) - [SLA Availability](https://techdocs.akamai.com/alerts-app/docs/sla-availability.md) - [SLA Performance](https://techdocs.akamai.com/alerts-app/docs/sla-perf.md) - [Stale playlist detected](https://techdocs.akamai.com/alerts-app/docs/stale-playlist-detected.md) - [Stream BitRate](https://techdocs.akamai.com/alerts-app/docs/stream-bitrate.md) - [Stream Failure](https://techdocs.akamai.com/alerts-app/docs/stream-failure.md) - [Stream Ingest Stopped](https://techdocs.akamai.com/alerts-app/docs/stream-ingest-stopped.md) - [Stream Start-up Time](https://techdocs.akamai.com/alerts-app/docs/stream-start-up-time.md) - [SureRoute Object Failure Alert](https://techdocs.akamai.com/alerts-app/docs/sureroute-object-failure-alert.md) - [Test Availability](https://techdocs.akamai.com/alerts-app/docs/test-availability.md) - [Too many HTTP errors from an MCDN cluster - reported by cluster, select CPcode](https://techdocs.akamai.com/alerts-app/docs/many-http-err-mcdn-cluster-rpted-cluster-select-cpcode.md) - [Too many requests on a SaaS configuration have no application-id defined](https://techdocs.akamai.com/alerts-app/docs/many-req-saas-config-have-no-app-id-defined.md) - [Too many requests on a SaaS configuration have no customer-id](https://techdocs.akamai.com/alerts-app/docs/many-req-saas-config-have-no-customer-id.md) - [Too many requests on a SaaS configuration have no user-id defined](https://techdocs.akamai.com/alerts-app/docs/many-req-saas-config-have-no-user-id-defined.md) - [Too many servers down or suspended within MCDN edge cache tier - reported by cluster](https://techdocs.akamai.com/alerts-app/docs/many-servers-down-suspended-within-mcdn-edge-cache-tier-rpted-cluster.md) - [Too many servers down or suspended within MCDN edge cache tier - reported by maprule](https://techdocs.akamai.com/alerts-app/docs/many-servers-down-suspended-within-mcdn-edge-cache-tier-rpted-maprule.md) - [Too many servers down or suspended within MCDN grandparent cache tier - reported by cluster](https://techdocs.akamai.com/alerts-app/docs/many-servers-down-suspended-within-mcdn-grandparent-cache-tier-rpted-cluster.md) - [Too many servers down or suspended within MCDN grandparent cache tier - reported by maprule](https://techdocs.akamai.com/alerts-app/docs/many-servers-down-suspended-within-mcdn-grandparent-cache-tier-rpted-maprule.md) - [Too many servers down or suspended within MCDN parent cache tier - reported by cluster](https://techdocs.akamai.com/alerts-app/docs/many-servers-down-suspended-within-mcdn-parent-cache-tier-rpted-cluster.md) - [Too many servers down or suspended within MCDN parent cache tier - reported by maprule](https://techdocs.akamai.com/alerts-app/docs/many-servers-down-suspended-within-mcdn-parent-cache-tier-rpted-maprule.md) - [Zone Approaching Resource Record Limit](https://techdocs.akamai.com/alerts-app/docs/zone-approaching-resource-record-limit.md) - [Zone SOA Ahead](https://techdocs.akamai.com/alerts-app/docs/zone-soa-ahead.md) - [Create an alert](https://techdocs.akamai.com/alerts-app/docs/create-an-alert.md) - [Edit an alert](https://techdocs.akamai.com/alerts-app/docs/edit-alert.md) - [Check alert's details and troubleshooting](https://techdocs.akamai.com/alerts-app/docs/check-alerts-details-trbl.md) - [Delete an alert](https://techdocs.akamai.com/alerts-app/docs/delete-alert.md) - [Download alerts' summary](https://techdocs.akamai.com/alerts-app/docs/dl-alerts-summary.md) - [Problems and solutions](https://techdocs.akamai.com/alerts-app/docs/faq-trbl.md) ## API Reference - [Alerts API](https://techdocs.akamai.com/alerts-app/reference/api.md) - [API summary](https://techdocs.akamai.com/alerts-app/reference/api-summary.md) - [Get started](https://techdocs.akamai.com/alerts-app/reference/api-get-started.md) - [API concepts](https://techdocs.akamai.com/alerts-app/reference/api-concepts.md) - [API workflows](https://techdocs.akamai.com/alerts-app/reference/workflows.md) - [API hypermedia](https://techdocs.akamai.com/alerts-app/reference/api-hypermedia.md) - [Rate limits](https://techdocs.akamai.com/alerts-app/reference/rate-limits.md) - [Errors](https://techdocs.akamai.com/alerts-app/reference/api-errors.md) - [400](https://techdocs.akamai.com/alerts-app/reference/400.md) - [401](https://techdocs.akamai.com/alerts-app/reference/401.md) - [403](https://techdocs.akamai.com/alerts-app/reference/403.md) - [404](https://techdocs.akamai.com/alerts-app/reference/404.md) - [405](https://techdocs.akamai.com/alerts-app/reference/405.md) - [409](https://techdocs.akamai.com/alerts-app/reference/409.md) - [415](https://techdocs.akamai.com/alerts-app/reference/415.md) - [500](https://techdocs.akamai.com/alerts-app/reference/500.md) - [List access control data](https://techdocs.akamai.com/alerts-app/reference/get-access-control-data.md): Lists items of relevant data available to you at runtime to apply to an alert definition. For example, when creating an alert about traffic levels for a set of CP codes, you can use this operation to list the set of CP codes to which you have access. - [List templates](https://techdocs.akamai.com/alerts-app/reference/get-templates.md): Lists templates for all supported alerts. Objects listed in the response provide only high-level information about each alert template, such as its `name` and whether its `origin` is `STATIC` or `ADAPTIVE`. For a full definition that specifies all required `fields`, get a [specific template instance](ref:get-template). - [Get a template](https://techdocs.akamai.com/alerts-app/reference/get-template.md): Fetches a specific template. The response features a full set of `fields` on which to base a [new alert definition](ref:post-definition). - [List alert summaries](https://techdocs.akamai.com/alerts-app/reference/get-summaries.md): Lists only high-level metadata about each alert: its name, ID, and when it was last fired. This operation wraps data available from other operations to generate simple, accessible listings. - [Get an alert summary](https://techdocs.akamai.com/alerts-app/reference/get-summaries-definition.md): Get the summary of basic metadata for a single alert. - [Get alert details](https://techdocs.akamai.com/alerts-app/reference/get-summaries-definition-details.md): Get verbose details for a single alert, including its definition, firings, and sparklines report. - [Create a new alert](https://techdocs.akamai.com/alerts-app/reference/post-definition.md): Creates a new alert definition based on a template. The template's required `fields` represent criteria you may use to trigger an alert, but the new definition's `fields` specify the set of values that actually trigger the alert. After you create a new alert, it may take a couple of minutes before it has enough information before it can fire. - [List alerts](https://techdocs.akamai.com/alerts-app/reference/get-definitions.md): Lists alert instances that are configured to fire under certain conditions. Optionally filter alerts by relevant fields or their values. - [Get an alert](https://techdocs.akamai.com/alerts-app/reference/get-definition.md): Get a single alert instance that is configured to fire under certain conditions. - [Update an alert](https://techdocs.akamai.com/alerts-app/reference/put-definition.md): Modifies the criteria that determine when an alert fires. - [Remove an alert](https://techdocs.akamai.com/alerts-app/reference/delete-definition.md): Deletes an alert and stops it from firing. It can take a few minutes to propagate alert deactivation. - [List adaptive alert activity log](https://techdocs.akamai.com/alerts-app/reference/get-definition-alert-activities.md): Lists a history of an alert definition's _modifications_. This operation only applies to adaptive alerts, and responds with an error if applied to a static alert. - [List fired alerts](https://techdocs.akamai.com/alerts-app/reference/get-definition-alert-firings.md): Lists a history of an alert definition's _firings_. Firings for the last 30 days are arranged chronologically in the `data` array, with the most recent at the end. This lists alerts that have a defined `endTime` to indicate they are no longer in progress. For others, run the [List active firings](ref:get-active-alert-firings) operation. - [Create a new modeling suppressions](https://techdocs.akamai.com/alerts-app/reference/post-definition-suppression.md): Creates a new time range for an adaptive alert definition that gets ignored when dynamically modeling its expected range of traffic. This operation only applies to adaptive alerts, and responds with an error if applied to a static alert. - [List modeling suppressions](https://techdocs.akamai.com/alerts-app/reference/get-definition-suppressions.md): Lists all time ranges for an adaptive alert definition that are ignored when dynamically modeling its expected range of traffic. This operation only applies to adaptive alerts, and responds with an error if applied to a static alert. - [Unsuppress alert modeling](https://techdocs.akamai.com/alerts-app/reference/delete-definition-suppression.md): Removes a suppression, and makes an adaptive alert definition reconsider a previously suppressed period of time when modeling your site's expected range of behavior. This operation only applies to adaptive alerts, and responds with an error if applied to a static alert. Suppressions that are too old to affect alert firings are automatically removed, so there is no need to run this operation simply to trim them from the [list of modeling suppressions](ref:get-definition-suppressions). - [List active alerts](https://techdocs.akamai.com/alerts-app/reference/get-active-alert-firings.md): Lists currently fired alerts. - [Count active alerts](https://techdocs.akamai.com/alerts-app/reference/get-active-alert-count.md): Get the number of active, currently fired alerts. - [List sparklines](https://techdocs.akamai.com/alerts-app/reference/get-sparklines.md): Lists _sparklines_, reports that plot anomalies that trigger firings over a time series. Each sparkline this operation lists corresponds to an alert definition. Specify more than one alert identifier to gather related data from different alerts for potential use in overlays, for example one sparkline to identify too much traffic, and another for too little traffic. Note that sparklines based on adaptive alerts provide observed data for both `anomalies` and the full range of `points`. Sparklines based on static alerts only provide observed data for `anomalies`, and the `points` simply define the range of the time series without any observed non-anomalous data. - [Get definition schema](https://techdocs.akamai.com/alerts-app/reference/get-schema-definition-template.md): Gets the JSON schema that describes the contents of a specific type of alert, depending on the template used to create it. This is useful to validate the contents of a [new alert request](ref:post-definition) before POSTing it. - [Get details schema](https://techdocs.akamai.com/alerts-app/reference/get-schema-details.md): Gets the JSON schema that describes the contents of a verbose set of alert details. - [Get firings schema](https://techdocs.akamai.com/alerts-app/reference/get-schema-firings.md): Gets the JSON schema that describes the contents of an alert firing. - [Get summary schema](https://techdocs.akamai.com/alerts-app/reference/get-schema-summaries.md): Gets the JSON schema that describes the contents of an alert summary. - [Get template schema](https://techdocs.akamai.com/alerts-app/reference/get-schema-template.md): Gets the JSON schema that describes the contents of an alert template. - [Get template header schema](https://techdocs.akamai.com/alerts-app/reference/get-schema-template-header.md): Template headers are the summaries that appear in template listings. This operation gets the JSON schema that describes their contents. ## Recipes - [Create a new alert](https://techdocs.akamai.com/alerts-app/recipes/create-a-new-alert.md) - [Create a new modeling suppressions](https://techdocs.akamai.com/alerts-app/recipes/create-a-new-modeling-suppressions.md) - [Get a template](https://techdocs.akamai.com/alerts-app/recipes/get-a-template.md) - [Get adaptive alert edit history](https://techdocs.akamai.com/alerts-app/recipes/get-adaptive-alert-edit-history.md) - [Get alert details](https://techdocs.akamai.com/alerts-app/recipes/get-alert-details.md) - [Get an alert](https://techdocs.akamai.com/alerts-app/recipes/get-an-alert-1.md) - [Get an alert summary](https://techdocs.akamai.com/alerts-app/recipes/get-an-alert-summary.md) - [Get definition schema](https://techdocs.akamai.com/alerts-app/recipes/get-definition-schema.md) - [List access control data](https://techdocs.akamai.com/alerts-app/recipes/list-access-control-data.md) - [List active alerts](https://techdocs.akamai.com/alerts-app/recipes/list-active-alerts.md) - [List alerts by definition](https://techdocs.akamai.com/alerts-app/recipes/list-alerts-by-definition.md) - [List alerts by fields](https://techdocs.akamai.com/alerts-app/recipes/list-alerts-by-fields.md) - [List fired alerts](https://techdocs.akamai.com/alerts-app/recipes/list-fired-alerts.md) - [List modeling suppressions](https://techdocs.akamai.com/alerts-app/recipes/list-modeling-suppressions.md) - [List sparklines](https://techdocs.akamai.com/alerts-app/recipes/list-sparklines.md) - [Remove an alert](https://techdocs.akamai.com/alerts-app/recipes/remove-an-alert-1.md) - [Unsuppress alert modeling](https://techdocs.akamai.com/alerts-app/recipes/unsuppress-alert-modeling.md) - [Update an alert](https://techdocs.akamai.com/alerts-app/recipes/update-an-alert-1.md) ## Changelog - [Jan 7, 2025 — New alerts available](https://techdocs.akamai.com/alerts-app/changelog/jan-7-2025-new-alerts-available.md) - [Jan 4, 2022 — New Alerts documentation experience](https://techdocs.akamai.com/alerts-app/changelog/jan-4-2022-new-alerts-documentation-experience.md) - [Mar 19, 2019 — Alerts now supports assigning alerts to specific groups](https://techdocs.akamai.com/alerts-app/changelog/alerts-now-supports-assigning-alerts-to-specific-groups.md) - [Sep 1, 2016 — Alerts has been redesigned to improve the overall user experience and usability](https://techdocs.akamai.com/alerts-app/changelog/alerts-has-been-redesigned-to-improve-the-overall-user-experience-and-usability.md) # API Acceleration Documentation > Akamai's API Acceleration improves the performance, security, and scalability of your APIs. API Acceleration has a specialized network of servers, metadata optimization, and mapping strategies designed to meet the unique requirements and challenges of delivering performant API and beacon traffic. ## Guides - [Welcome to API Acceleration](https://techdocs.akamai.com/api-acceleration/docs/welcome-api-accel.md): Learn how to improve the performance, security, and scalability of your APIs. - [Define your project](https://techdocs.akamai.com/api-acceleration/docs/plan-impl-project.md): Determine resources to ensure a successful implementation. - [Best practices and tips](https://techdocs.akamai.com/api-acceleration/docs/best-practices-tips.md) - [Configure API Acceleration](https://techdocs.akamai.com/api-acceleration/docs/config-api-accel.md) - [Set up SureRoute test object](https://techdocs.akamai.com/api-acceleration/docs/setup-sureroute-test-object.md) - [Identify origin server](https://techdocs.akamai.com/api-acceleration/docs/identify-origin-server.md) - [Create your API Acceleration property](https://techdocs.akamai.com/api-acceleration/docs/customize-rules-beh-settings.md) - [Test on staging](https://techdocs.akamai.com/api-acceleration/docs/test-stage.md) - [Go live](https://techdocs.akamai.com/api-acceleration/docs/go-live.md) - [Create alerts](https://techdocs.akamai.com/api-acceleration/docs/run-rpts-create-alerts.md) ## Changelog - [Jan 30, 2026 – Support for gRPC Web](https://techdocs.akamai.com/api-acceleration/changelog/jan-30-2026-support-for-grpc-web.md) - [Oct 8, 2024 – Update to Origin IP ACL support](https://techdocs.akamai.com/api-acceleration/changelog/oct-8-2024-update-to-origin-ip-acl-support.md) - [Mar 25, 2024 – Edge IP Binding support](https://techdocs.akamai.com/api-acceleration/changelog/mar-25-2024-edge-ip-binding-support.md) - [Jan 11, 2024 – Client Hints support](https://techdocs.akamai.com/api-acceleration/changelog/jan-11-2024-client-hints-support.md) - [Dec 18, 2023 — Support for mTLS](https://techdocs.akamai.com/api-acceleration/changelog/dec-18-2023-support-for-mtls.md) # API Definitions Documentation > Akamai's API Definitions lets you register, manage, and deliver your APIs via Akamai in an efficient and secure manner. Several products and features utilize API definitions, including: API Acceleration, API Discovery, API Gateway, Bot Manager, Kona Site Defender, and API protector with ASM module. ## Guides - [Welcome to API Definitions](https://techdocs.akamai.com/api-definitions/docs/welcome-api-definitions.md) - [Prerequisites](https://techdocs.akamai.com/api-definitions/docs/before-begin.md) - [Key concepts and terms](https://techdocs.akamai.com/api-definitions/docs/glossary.md) - [Register an API](https://techdocs.akamai.com/api-definitions/docs/register-api.md) - [Generate good API resource paths](https://techdocs.akamai.com/api-definitions/docs/parameters-wildcards-in-basepath.md) - [Access control group (ACG) model](https://techdocs.akamai.com/api-definitions/docs/access-control-grp-acg-model.md) - [Define GraphQL endpoints](https://techdocs.akamai.com/api-definitions/docs/define-graphql-endpoints.md) - [Add API resources](https://techdocs.akamai.com/api-definitions/docs/add-api-resources.md) - [Set up an operation](https://techdocs.akamai.com/api-definitions/docs/set-up-resource-purposes.md) - [Multistep groups](https://techdocs.akamai.com/api-definitions/docs/multistep-groups.md) - [Operation purposes](https://techdocs.akamai.com/api-definitions/docs/operation-purposes-1.md) - [Set origin success and failure conditions](https://techdocs.akamai.com/api-definitions/docs/set-origin-success-and-failure-conditions.md) - [Set API constraints](https://techdocs.akamai.com/api-definitions/docs/set-api-req-body-resource-constraints.md) - [API Protections enhancement in April 2022](https://techdocs.akamai.com/api-definitions/docs/api-protections-enhancement-in-april-2022.md) - [Personally identifiable information (PII) learning](https://techdocs.akamai.com/api-definitions/docs/personally-identifiable-information-discovery.md) - [Enable response constraints](https://techdocs.akamai.com/api-definitions/docs/response-constraints.md) - [Set response body and resource constraints](https://techdocs.akamai.com/api-definitions/docs/set-response-body-and-resource-constraints.md) - [Enforcing PII constraints (Beta)](https://techdocs.akamai.com/api-definitions/docs/pii-constraints.md) - [Register an API parameter with PII](https://techdocs.akamai.com/api-definitions/docs/add-an-api-parameter-with-pii.md): Add a parameter with PII to a registered API. - [Respond to API PII recommendations](https://techdocs.akamai.com/api-definitions/docs/respond-to-pii-recommendations.md) - [PII exclusions (Beta)](https://techdocs.akamai.com/api-definitions/docs/pii-exclusions.md) - [Respond to PII in unregistered APIs](https://techdocs.akamai.com/api-definitions/docs/respond-to-pii-in-unregistered-apis.md) - [Import API definition file](https://techdocs.akamai.com/api-definitions/docs/api-def-file-import.md) - [Registered APIs list](https://techdocs.akamai.com/api-definitions/docs/registered-apis-list.md) - [API configuration version management](https://techdocs.akamai.com/api-definitions/docs/api-config-version-mgmt.md) - [API Discovery overview and access](https://techdocs.akamai.com/api-definitions/docs/api-discovery-ov.md) - [Detected API list](https://techdocs.akamai.com/api-definitions/docs/detected-api-list.md) - [Detected API details](https://techdocs.akamai.com/api-definitions/docs/detected-api-details.md) - [Filter API entries](https://techdocs.akamai.com/api-definitions/docs/filter-api-entries.md) - [Export detected API data](https://techdocs.akamai.com/api-definitions/docs/export-detected-api-data.md) - [Hide an API](https://techdocs.akamai.com/api-definitions/docs/hide-api.md) - [Report an API as misidentified](https://techdocs.akamai.com/api-definitions/docs/report-api-misidentified.md) - [API Gateway overview](https://techdocs.akamai.com/api-definitions/docs/api-gateway-ov.md) - [Implement API Gateway](https://techdocs.akamai.com/api-definitions/docs/impl-api-gateway.md) - [Set up edge servers](https://techdocs.akamai.com/api-definitions/docs/set-up-edge-servers.md) - [Establish an SSL certificate in CPS](https://techdocs.akamai.com/api-definitions/docs/establish-ssl-cert-cert-prov-system.md) - [Add permissions to a user role](https://techdocs.akamai.com/api-definitions/docs/add-permissions-user-role.md) - [Create and configure a property](https://techdocs.akamai.com/api-definitions/docs/create-config-prop.md) - [Configure property hostname settings](https://techdocs.akamai.com/api-definitions/docs/config-props-hn-settings.md) - [Set up your API configuration for testing](https://techdocs.akamai.com/api-definitions/docs/setup-api-config-testing.md) - [Activate API Gateway on production](https://techdocs.akamai.com/api-definitions/docs/activate-api-gateway-prod.md) - [API versioning](https://techdocs.akamai.com/api-definitions/docs/api-versioning.md) - [API Gateway delivery settings](https://techdocs.akamai.com/api-definitions/docs/api-gateway-deliv-settings.md) - [JSON web token (JWT) validation](https://techdocs.akamai.com/api-definitions/docs/json-web-token-jwt-val.md) - [Cross-origin resource sharing (CORS)](https://techdocs.akamai.com/api-definitions/docs/cross-origin-resource-sharing-cors.md) - [Caching](https://techdocs.akamai.com/api-definitions/docs/caching.md) - [GraphQL caching](https://techdocs.akamai.com/api-definitions/docs/graphql-caching.md) - [GZIP compression](https://techdocs.akamai.com/api-definitions/docs/gzip-comp.md) - [Error response customization](https://techdocs.akamai.com/api-definitions/docs/err-response-custom.md) - [Request routing and forwarding](https://techdocs.akamai.com/api-definitions/docs/req-routing-forwarding.md) - [API Gateway reports](https://techdocs.akamai.com/api-definitions/docs/api-gateway-reports.md) - [API Gateway dashboard](https://techdocs.akamai.com/api-definitions/docs/api-gateway-dashboard.md) - [About API keys and traffic management](https://techdocs.akamai.com/api-definitions/docs/about-api-keys-traffic-management.md) ## API Reference - [API Endpoint Definition API](https://techdocs.akamai.com/api-definitions/reference/api.md) - [Versioning](https://techdocs.akamai.com/api-definitions/reference/api-version.md) - [API summary](https://techdocs.akamai.com/api-definitions/reference/api-summary.md) - [Get started](https://techdocs.akamai.com/api-definitions/reference/api-get-started.md) - [Reporting](https://techdocs.akamai.com/api-definitions/reference/reporting.md) - [API concepts](https://techdocs.akamai.com/api-definitions/reference/api-concepts.md) - [Concurrency control](https://techdocs.akamai.com/api-definitions/reference/concurrency-control.md) - [Operation purposes](https://techdocs.akamai.com/api-definitions/reference/operation-purposes.md) - [API workflows](https://techdocs.akamai.com/api-definitions/reference/api-workflows.md) - [Make a JSON request to register an endpoint from an API definition file](https://techdocs.akamai.com/api-definitions/reference/endpoint-request-json.md) - [Make a form request to register an endpoint from an API definition file](https://techdocs.akamai.com/api-definitions/reference/endpoint-request-form.md) - [Make a JSON request to edit an endpoint from an API definition file](https://techdocs.akamai.com/api-definitions/reference/endpoint-edit-json.md) - [Make a form request to edit an endpoint from an API definition file](https://techdocs.akamai.com/api-definitions/reference/endpoint-edit-form.md) - [Errors](https://techdocs.akamai.com/api-definitions/reference/api-errors.md) - [400](https://techdocs.akamai.com/api-definitions/reference/400.md) - [401](https://techdocs.akamai.com/api-definitions/reference/401.md) - [403](https://techdocs.akamai.com/api-definitions/reference/403.md) - [404](https://techdocs.akamai.com/api-definitions/reference/404.md) - [405](https://techdocs.akamai.com/api-definitions/reference/405.md) - [409](https://techdocs.akamai.com/api-definitions/reference/409.md) - [412](https://techdocs.akamai.com/api-definitions/reference/412.md) - [500](https://techdocs.akamai.com/api-definitions/reference/500.md) - [Error types](https://techdocs.akamai.com/api-definitions/reference/error-types.md) - [List contracts and groups](https://techdocs.akamai.com/api-definitions/reference/get-contracts-groups.md): You provision each API endpoint within the context of your contract with Akamai and a Control Center portal group. The response objects encapsulate pairings of contract and group identifiers available within the scope of the user who provisioned the API token, as described in [Get started](ref:api-get-started). - [List hostnames](https://techdocs.akamai.com/api-definitions/reference/get-contract-group-hosts.md): Lists all hostnames through which API consumers can access an endpoint service under a given contract and group pairing. You can use Property Manager (or [PAPI](https://techdocs.akamai.com/property-mgr/reference/api)) to create new hostnames to make available to users. - [List hostnames with access control groups](https://techdocs.akamai.com/api-definitions/reference/get-contract-group-hosts-acgs.md): Lists all hostnames through which API consumers can access an endpoint service under a given contract and group pairing. Returns each hostname together with the access control group where the hostname is registered. You can use Property Manager (or [PAPI](https://techdocs.akamai.com/property-mgr/reference/api)) to create new hostnames to make available to users. - [Create a category](https://techdocs.akamai.com/api-definitions/reference/post-category.md): Creates a category that you can use to tag endpoints. The request's `apiCategoryName` needs to be unique per account. - [List categories](https://techdocs.akamai.com/api-definitions/reference/get-categories.md): Lists all categories available to tag endpoints and optionally indicates the number of endpoints tagged under each category. - [Get a category](https://techdocs.akamai.com/api-definitions/reference/get-category.md): Returns a specific category that you can use to tag endpoints. - [Edit a category](https://techdocs.akamai.com/api-definitions/reference/put-category.md): Updates a category's description or unique name. - [Delete a category](https://techdocs.akamai.com/api-definitions/reference/delete-category.md): Removes an unassigned category. If you assigned the category to at least one endpoint, the operation returns a 403 error. - [Register an endpoint](https://techdocs.akamai.com/api-definitions/reference/post-endpoints.md): Creates the first version of an API endpoint configuration. You can specify the new endpoint's full set of resources. Alternatively, you can create them later either by modifying the endpoint object, or separately with the [Create a resource](ref:post-resource) operation. The endpoint's name needs to be unique within an account. - [List endpoints](https://techdocs.akamai.com/api-definitions/reference/get-endpoints.md): Lists the available API endpoints, with results optionally paginated, sorted, and filtered. If no endpoints are available, the operation responds with an empty array. - [Clone an endpoint](https://techdocs.akamai.com/api-definitions/reference/post-endpoint-clone.md): Creates an endpoint as a clone from the specified source endpoint ID and version. - [Register an endpoint from an API definition file](https://techdocs.akamai.com/api-definitions/reference/post-endpoints-file.md): Imports an API definition file and creates a new endpoint based on the file contents, optionally stripping out request or response body specifications. You can run this operation in two ways. To POST JSON data, see [Make a JSON request to register an endpoint from an API definition file](ref:endpoint-request-json). To make a form request using these parameters, see [Make a form request to register an endpoint from an API definition file](ref:endpoint-request-form). - [List user entitlements](https://techdocs.akamai.com/api-definitions/reference/get-user-entitlements.md): Lists user entitlements based on your assigned permissions. It helps you determine if your user identity assigned to the API client can run various other operations to modify data. See [Get started](ref:api-get-started) for details on setting up the API client with the appropriate level of access. This operation's array values include `API_READ` for read-only access, `API_WRITE` for modifying the existing endpoint versions, `API_VERSIONING` for version management, `API_FEATURES` for access to App & API Protector security features, `AAG_FEATURES` for access to delivery features, and `API_PURPOSE` for access to resource purpose settings. Note that the `API_FEATURES` permission is only available for App & API Protector customers, and the `API_PURPOSE` permission is for Bot Manager customers. - [Verify secure connection](https://techdocs.akamai.com/api-definitions/reference/post-endpoints-verify-secure-connection.md): Verifies that provided hostnames are signed with a provided certificate chain. This ensures that edge servers can connect to the hostnames securely. The response is a map of hostnames to connection status values. For the list of available connection status values and their descriptions, see Connection status values. You can use the response information when setting up JWKS in the [Edit JWT settings](ref:put-jwt-settings) operation. - [Delete an endpoint](https://techdocs.akamai.com/api-definitions/reference/delete-endpoint.md): Removes an endpoint configuration from API Gateway if none of the endpoint's versions are active or pending activation on the staging or production network. - [Hide an endpoint](https://techdocs.akamai.com/api-definitions/reference/post-endpoint-hide.md): Hides an endpoint and all its versions. You can only hide an endpoint with no active versions on the staging or production network. You can't activate or delete versions of a hidden endpoint. A hidden endpoint appears in the [List endpoints](ref:get-endpoints) operation's response object by default, or when you set the operation's `show` query parameter to `ONLY_HIDDEN`. Running this operation affects the endpoint listing in the API Definitions user interface. - [Show an endpoint](https://techdocs.akamai.com/api-definitions/reference/post-endpoint-show.md): Reveals a hidden endpoint and all its versions. A revealed endpoint appears in the [List endpoints](ref:get-endpoints) operation's response object by default, or when you set the operation's `show` query parameter to `ONLY_VISIBLE`. Running this operation affects the endpoint listing in the API Definitions user interface. - [List versions](https://techdocs.akamai.com/api-definitions/reference/get-endpoint-versions.md): Returns versions of an endpoint, with results optionally paginated, sorted, and filtered. - [Get a version summary](https://techdocs.akamai.com/api-definitions/reference/get-endpoint-version.md): Returns a summary for a specific endpoint version. The summary is for purely informational purposes, and you shouldn't use this operation's response in the corresponding [Edit a version](ref:put-endpoint-version) PUT request. For the PUT request, use the response object of [Get a version](ref:get-endpoint-version-resource). - [Edit a version](https://techdocs.akamai.com/api-definitions/reference/put-endpoint-version.md): Updates details about an endpoint version that has never been activated on the staging or production network. You can configure the endpoint's security settings and other top-level metadata, or modify the endpoint's entire set of resources as an alternative to separate calls to [Edit a resource](ref:put-version-resource). Note that the corresponding [Get a version](ref:get-endpoint-version-resource) operation you need to run to GET the data uses a different URL. - [Delete a version](https://techdocs.akamai.com/api-definitions/reference/delete-endpoint-version.md): Removes an endpoint version from API Gateway if the version has never been activated on the staging or production network. This is a soft delete operation that preserves the version's information, such as its number, in the database. You can't remove the permanent number assigned to each endpoint version, even if you remove that version. A removed endpoint version no longer appears in the [List versions](ref:get-endpoint-versions) operation's response object. - [Activate a version](https://techdocs.akamai.com/api-definitions/reference/post-endpoint-version-activate.md): Activates an endpoint version on the staging or production network. If another version of the endpoint is already active on the specified network, that version automatically deactivates and the newly activated version takes its place. If an active version of another endpoint shares any hostnames with the version you activate, the API automatically deactivates the version with conflicting hostnames, creates a new version of the impacted endpoint, migrates the non-conflicting hostnames and other API details to the new version, and activates the new version. - [Clone a version](https://techdocs.akamai.com/api-definitions/reference/post-endpoint-version-clone.md): Creates a new endpoint version as a clone of an existing version. The system assigns a new number to the version that you clone. - [Deactivate a version](https://techdocs.akamai.com/api-definitions/reference/post-endpoint-version-deactivate.md): Deactivates an endpoint version on the staging or production network. A deactivated endpoint version no longer serves traffic through the Akamai network. - [Edit an endpoint from an API definition file](https://techdocs.akamai.com/api-definitions/reference/post-endpoint-version-file.md): Imports an API definition file with details about an endpoint. Unlike [Register an endpoint from an API definition file](ref:post-endpoints-file), this operation doesn't create a new endpoint, but updates details of an existing endpoint. You can run this operation in two ways. To POST JSON data, see [Make a JSON request to edit an endpoint from an API definition file](ref:endpoint-edit-json). To make a form request using these parameters, see [Make a form request to edit an endpoint from an API definition file](ref:endpoint-edit-form). Once you submit the POST request, to finish modifying the endpoint version, you need to take the response data and submit it as a request to the [Edit a version](ref:put-endpoint-version) operation. - [Hide a version](https://techdocs.akamai.com/api-definitions/reference/post-endpoint-version-hide.md): Hides an endpoint version. You can only hide inactive or deactivated versions. You can't activate or delete hidden versions. A hidden endpoint version appears in the [List versions](ref:get-endpoint-versions) operation's response object with the `hidden` parameter set to `true`. Running this operation affects the version listing in the API Definitions user interface. - [Show a version](https://techdocs.akamai.com/api-definitions/reference/post-version-show.md): Reveals a hidden endpoint version. A revealed endpoint version appears in the [List versions](ref:get-endpoint-versions) operation's response object with the `hidden` parameter set to `false`. Running this operation affects the version listing in the API Definitions user interface. - [List parameters with PII for an endpoint version](https://techdocs.akamai.com/api-definitions/reference/get-endpoint-version-piis.md): Returns all PII objects for an endpoint version. This includes parameters with PII already in your API definition, as well as parameters with PII the network discovers on your behalf. You can return this information for both active and inactive endpoint versions. All operations for PII are per endpoint version. Run [Enable PII learning settings for a configuration](https://techdocs.akamai.com/application-security/reference/put-advanced-settings-pii-learning) to use this feature. - [Add or update a user-created PII instance](https://techdocs.akamai.com/api-definitions/reference/post-endpoint-version-piis-parameter.md): Adds or updates PII in an API parameter. This is for you to add to or modify in your API definition yourself, rather than the network discovering the PII for you. - [Modify PII settings for an endpoint version](https://techdocs.akamai.com/api-definitions/reference/post-endpoint-version-pii-settings.md): Update the PII settings in an endpoint version. These settings are for a PII object per endpoint version, so if you have the same object in multiple endpoint versions, you'll need to run the operation for each version. This includes parameters with PII already in your API definition, as well as parameters with PII the network discovers on your behalf. You can return this information for both active and inactive endpoint versions. All operations for PII are per endpoint version. Run [Enable PII learning settings for a configuration](https://techdocs.akamai.com/application-security/reference/put-advanced-settings-pii-learning) to use this feature. - [List PII settings for an endpoint version](https://techdocs.akamai.com/api-definitions/reference/get-endpoint-version-pii-settings.md): Returns the PII settings in an endpoint version, including the inspection scope and constraints, and how you want the network to handle PII. - [Modify PII status per endpoint version](https://techdocs.akamai.com/api-definitions/reference/post-endpoint-version-pii-status-from-register-form.md): Update the PII status. This operation applies to PII found by the network and not PII you add to your API definition yourself. - [Delete PII in an endpoint version](https://techdocs.akamai.com/api-definitions/reference/delete-endpoint-version-pii.md): Removes a PII object from your API endpoint definition for the version you specify. If you want to delete the PII object from all the versions where it exists, you'll need to make this request for each version of the endpoint. - [Patch PII status per endpoint version](https://techdocs.akamai.com/api-definitions/reference/patch-endpoint-version-pii-status.md): Update the PII status. This operation applies to PII found by the network and not PII you add to your API definition yourself. - [Create a resource](https://techdocs.akamai.com/api-definitions/reference/post-resource.md): Creates a resource in an endpoint version. The resource's full URL (concatenated hostname, `basePath`, and `resourcepath`) needs to be unique within the account. You can only create resources for versions that have never been activated on the staging or production network. - [List resources](https://techdocs.akamai.com/api-definitions/reference/get-endpoint-version-resources.md): Lists all resources assigned to an endpoint version. You can use the `apiResourceId` of each returned resource to modify resources individually through the [Edit a resource](ref:put-version-resource) operation, or run the [Edit a version](ref:put-endpoint-version) operation to batch-modify a group of resources. - [Get a version](https://techdocs.akamai.com/api-definitions/reference/get-version-details.md): Returns an endpoint version. Use this operation's response object when modifying an endpoint version through [Edit a version](ref:put-endpoint-version). Don't use [Get a version summary](ref:get-endpoint-version) for the [Edit a version](ref:put-endpoint-version) operation. - [Get a resource](https://techdocs.akamai.com/api-definitions/reference/get-endpoint-version-resource.md): Returns a resource within an endpoint version. - [Edit a resource](https://techdocs.akamai.com/api-definitions/reference/put-version-resource.md): Updates a resource within an endpoint version. You can edit information about a resource, the methods, and the parameters assigned to a resource. You can only modify resources assigned to versions that have never been activated on the staging or production network. - [Delete a resource](https://techdocs.akamai.com/api-definitions/reference/delete-endpoint-version-resource.md): Removes a resource from an endpoint version. You can only remove resources assigned to versions that have never been activated on the staging or production network. - [Get API privacy settings](https://techdocs.akamai.com/api-definitions/reference/get-api-privacy-settings.md): Returns the API privacy settings configured for an endpoint version and its assigned resources. - [Edit API privacy settings](https://techdocs.akamai.com/api-definitions/reference/put-api-privacy-settings.md): Updates the API privacy settings configured for an endpoint version and its assigned resources. - [Get cache settings](https://techdocs.akamai.com/api-definitions/reference/get-cache-settings.md): Returns the caching settings configured for an endpoint version and its assigned resources. You can set all objects independently from the root `customize` field. - [Edit cache settings](https://techdocs.akamai.com/api-definitions/reference/put-cache-settings.md): Updates the caching settings configured for an endpoint version and its assigned resources. - [Get CORS settings](https://techdocs.akamai.com/api-definitions/reference/get-cors-settings.md): Returns the cross-origin resource sharing (CORS) settings configured for an endpoint version. - [Edit CORS settings](https://techdocs.akamai.com/api-definitions/reference/put-cors-settings.md): Updates the cross-origin resource sharing (CORS) settings configured for an endpoint version. - [Get error response settings](https://techdocs.akamai.com/api-definitions/reference/get-error-response-setting.md): Returns the error response settings configured for an endpoint version. - [Edit error response settings](https://techdocs.akamai.com/api-definitions/reference/put-error-response-setting.md): Updates the error response settings configured for an endpoint version. - [Get an error response](https://techdocs.akamai.com/api-definitions/reference/get-error-responses-type.md): Returns a customizable error response of the selected type. - [Edit an error response](https://techdocs.akamai.com/api-definitions/reference/put-get-error-responses-type.md): Updates a customizable error response of the selected type. - [Get GraphQL cache settings](https://techdocs.akamai.com/api-definitions/reference/get-graphql-settings.md): Returns the GraphQL caching settings configured for an endpoint version. - [Edit GraphQL cache settings](https://techdocs.akamai.com/api-definitions/reference/put-graphql-settings.md): Updates the GraphQL caching settings configured for an endpoint version. - [Get GZIP settings](https://techdocs.akamai.com/api-definitions/reference/get-gzip-settings.md): Returns the GZIP compression settings configured for an endpoint version. - [Edit GZIP settings](https://techdocs.akamai.com/api-definitions/reference/put-gzip-settings.md): Updates the GZIP compression settings configured for an endpoint version. - [Get JWT settings](https://techdocs.akamai.com/api-definitions/reference/get-jwt-settings.md): Returns the JWT validation settings configured for an endpoint version and its assigned resources. - [Edit JWT settings](https://techdocs.akamai.com/api-definitions/reference/put-jwt-settings.md): Updates the JWT validation settings configured for an endpoint version and its assigned resources. - [Get routing settings](https://techdocs.akamai.com/api-definitions/reference/get-routing-settings.md): Returns the incoming request's routing, forwarding, and SureRoute settings configured for an endpoint version. You can run this operation if you're taking part in the API Gateway beta program. - [Edit routing settings](https://techdocs.akamai.com/api-definitions/reference/put-routing-settings.md): Updates the incoming request's routing, forwarding, and SureRoute settings configured for an endpoint version. You can run this operation if you're taking part in the API Gateway beta program. - [Create a multistep group](https://techdocs.akamai.com/api-definitions/reference/post-multistep-group-details.md): Create a multistep group with a chosen name. To add operations and create a multistep flow, you need to [list](ref:get-resources-and-operations) resource operations, and then [get](ref:get-resource-operation) and [update](ref:put-resource-operation) each applicable operation to assign it a `multistepGroupId`. - [List multistep group details](https://techdocs.akamai.com/api-definitions/reference/get-multistep-group-details.md): Get the multistep group's name. To find out which operations are a part of this multistep group,[list](ref:get-resources-and-operations) resource operations and check their `multistepGroupId`. - [Get a multistep group](https://techdocs.akamai.com/api-definitions/reference/get-multistep-groups.md): Get the multistep group's name. To find out which operations are a part of this multistep group, [list](ref:get-resources-and-operations) resource operations and check their 'multistepGroupId'. - [Update a multistep group](https://techdocs.akamai.com/api-definitions/reference/put-multistep-groups.md): Change the multistep group's name. To assign an operation to a multistep group, modify its 'multistepGroupId' value. You can only add any given operation to a single group. - [Delete a multistep group](https://techdocs.akamai.com/api-definitions/reference/delete-multistep-groups.md): Remove a specific multistep group. This also deletes all operations in this group. - [List resources and operations](https://techdocs.akamai.com/api-definitions/reference/get-resources-and-operations.md): List all of your resources and resource operations for an API endpoint. - [Create a resource operation](https://techdocs.akamai.com/api-definitions/reference/post-resource-operation.md): Create a resource operation. These operations define the purposes of your API resources. Use them to identify the expected usage of your resources to protect endpoints from bot traffic. - [List resource operations](https://techdocs.akamai.com/api-definitions/reference/get-resource-operations.md): List all of your resource operations and their resources. - [Get a resource operation](https://techdocs.akamai.com/api-definitions/reference/get-resource-operation.md): Get details about a specific resource operation. - [Update a resource operation](https://techdocs.akamai.com/api-definitions/reference/put-resource-operation.md): Update details about a resource operation. You can change the operation's name, method, purpose, and more. - [Delete a resource operation](https://techdocs.akamai.com/api-definitions/reference/delete-resource-operation.md): Remove a specific resource operation. - [Query operations](https://techdocs.akamai.com/api-definitions/reference/post-search-operation.md): Get a filtered list of operations and their endpoints and resources. You can filter by date ranges, activation statuses, API Endpoint hostnames, and resource paths. For a simpler search, run [Search operations](ref:get-search-operations). - [Search operations](https://techdocs.akamai.com/api-definitions/reference/get-search-operations.md): Get a filtered list of operations and their endpoints and resources. Use `queryType` to filter by date ranges or activation statuses. For more complex queries, run [Query operations](ref:post-search-operation). - [Verify existing operations](https://techdocs.akamai.com/api-definitions/reference/post-operation.md): Verify that operations exist. Specify a list of operation summaries and receive a list of matching operations and their details, along with any submission errors. ## Recipes - [List endpoints](https://techdocs.akamai.com/api-definitions/recipes/list-endpoints.md) - [Query operations](https://techdocs.akamai.com/api-definitions/recipes/query-operations.md) - [Search operations](https://techdocs.akamai.com/api-definitions/recipes/search-operations.md) ## Changelog - [Nov 19, 2025 – Caching update](https://techdocs.akamai.com/api-definitions/changelog/nov-19-2025-caching-update.md) - [June 30th, 2025 – Open API for Bot and Abuse products](https://techdocs.akamai.com/api-definitions/changelog/june-30th-2025-open-api-for-bot-and-abuse-products.md) - [Oct 7, 2024 – Account Lifecycle Protection is generally available (GA)](https://techdocs.akamai.com/api-definitions/changelog/oct-7-2024-account-lifecycle-protection-is-generally-available-ga.md) - [Jul 23, 2024 – Flexible Workflow Configuration support is generally available (GA)](https://techdocs.akamai.com/api-definitions/changelog/jul-23-2024-flexible-workflow-configuration-support-is-generally-available-ga.md) - [Jun 5, 2024 – Account protection requires the username parameter for account verification and password reset](https://techdocs.akamai.com/api-definitions/changelog/jun-5-2024-account-protection-requires-the-username-parameter-for-account-verification-and-password-reset.md) # API Keys and Traffic Management Documentation > Akamai's API Keys and Traffic Management lets you create and manage API keys that serve as unique identifiers for API consumers. API keys exist inside top-level units called key collections. At the key collection level, you can set a quota limit for the number of successful requests that individual API clients can make. You can also edit access control lists (ACLs) associated with your API endpoints and resources. Together with the API Endpoint Definition API, you can use this API to programmatically deploy your APIs on the Akamai network. ## Guides - [Welcome to API Keys and Traffic Management](https://techdocs.akamai.com/key-traffic-mgmt/docs/api-keys-traffic-mgmt.md) - [Key collections](https://techdocs.akamai.com/key-traffic-mgmt/docs/key-clts.md) - [Create a key collection](https://techdocs.akamai.com/key-traffic-mgmt/docs/create-key-clt.md) - [Edit a key collection](https://techdocs.akamai.com/key-traffic-mgmt/docs/edit-key-clt.md) - [Delete a key collection](https://techdocs.akamai.com/key-traffic-mgmt/docs/delete-key-clt.md) - [User quota](https://techdocs.akamai.com/key-traffic-mgmt/docs/user-quota.md) - [Access control lists](https://techdocs.akamai.com/key-traffic-mgmt/docs/access-control-lists.md) - [Key operations](https://techdocs.akamai.com/key-traffic-mgmt/docs/key-op.md) - [API throttling](https://techdocs.akamai.com/key-traffic-mgmt/docs/api-throttling.md) - [API throttling configuration](https://techdocs.akamai.com/key-traffic-mgmt/docs/api-throttling-config.md) - [Manage throttling counter](https://techdocs.akamai.com/key-traffic-mgmt/docs/manage-throttling-counter.md) - [Add a throttling condition](https://techdocs.akamai.com/key-traffic-mgmt/docs/add-throttling-condition.md) ## API Reference - [API Keys and Traffic Management API](https://techdocs.akamai.com/key-traffic-mgmt/reference/api-keys-and-traffic-management-api.md) - [API summary](https://techdocs.akamai.com/key-traffic-mgmt/reference/api-summary.md) - [Get started](https://techdocs.akamai.com/key-traffic-mgmt/reference/get-started.md) - [API concepts](https://techdocs.akamai.com/key-traffic-mgmt/reference/api-concepts.md) - [Throttle API traffic](https://techdocs.akamai.com/key-traffic-mgmt/reference/throttle-api-traffic.md) - [Control API access and usage](https://techdocs.akamai.com/key-traffic-mgmt/reference/control-api-access-and-usage.md) - [API workflow](https://techdocs.akamai.com/key-traffic-mgmt/reference/api-workflow.md) - [Errors](https://techdocs.akamai.com/key-traffic-mgmt/reference/api-errors.md) - [400](https://techdocs.akamai.com/key-traffic-mgmt/reference/400.md) - [401](https://techdocs.akamai.com/key-traffic-mgmt/reference/401.md) - [403](https://techdocs.akamai.com/key-traffic-mgmt/reference/403.md) - [404](https://techdocs.akamai.com/key-traffic-mgmt/reference/404.md) - [405](https://techdocs.akamai.com/key-traffic-mgmt/reference/405.md) - [500](https://techdocs.akamai.com/key-traffic-mgmt/reference/500.md) - [Create a key collection](https://techdocs.akamai.com/key-traffic-mgmt/reference/post-collection.md): Creates an empty collection under the selected contract and group. - [List key collections](https://techdocs.akamai.com/key-traffic-mgmt/reference/get-collections.md): Returns information about all collections available for the current contract and group. - [Get a key collection](https://techdocs.akamai.com/key-traffic-mgmt/reference/get-collection.md): Returns information about a collection. - [Edit a key collection](https://techdocs.akamai.com/key-traffic-mgmt/reference/put-collection.md): Updates a collection. - [Delete a key collection](https://techdocs.akamai.com/key-traffic-mgmt/reference/delete-collection.md): Deletes a collection and any keys the collection includes that aren't assigned to other collections. - [Get an ACL](https://techdocs.akamai.com/key-traffic-mgmt/reference/get-collection-acl-entries.md): Returns the access control list of a collection. - [Edit an ACL](https://techdocs.akamai.com/key-traffic-mgmt/reference/put-collection-acl-entries.md): Updates the access control list of a collection by adding or removing endpoint, resource, and HTTP method information from the ACL. - [List collection endpoints](https://techdocs.akamai.com/key-traffic-mgmt/reference/get-collection-endpoints.md): Lists all endpoints assigned to the contract and group where you created the collection. The [API Endpoints API](https://techdocs.akamai.com/api-gateway/reference/api) manages this operation's response data format. - [Import keys](https://techdocs.akamai.com/key-traffic-mgmt/reference/post-collection-import-keys.md): Imports keys from a CSV, XML, or JSON file to a collection. When making a request to import keys, embed the data structure that defines the contents of the import file in a JSON object. See the [examples of the files](doc:key-op#import-keys). - [Returns collection keys in JSON, XML or CSV format](https://techdocs.akamai.com/key-traffic-mgmt/reference/get-export-collection-keys.md): Returns information about all collection keys in the JSON, XML or CSV format. - [Get quota settings](https://techdocs.akamai.com/key-traffic-mgmt/reference/get-collection-quota-config.md): Returns information about the quota settings in a collection. - [Edit quota settings](https://techdocs.akamai.com/key-traffic-mgmt/reference/put-collection-quota-config.md): Updates the quota settings in a collection. - [Reset collection key quota](https://techdocs.akamai.com/key-traffic-mgmt/reference/post-collections-quota-reset.md): Resets the quota limit for selected keys in this particular collection. - [Create a throttling counter](https://techdocs.akamai.com/key-traffic-mgmt/reference/post-counter.md): Creates a new throttling counter under the selected contract and group. - [List throttling counters](https://techdocs.akamai.com/key-traffic-mgmt/reference/get-counters.md): Returns all existing throttling counters available for the current contract and group. - [Get a throttling counter](https://techdocs.akamai.com/key-traffic-mgmt/reference/get-counter.md): Returns information about a throttling counter. - [Edit a throttling counter](https://techdocs.akamai.com/key-traffic-mgmt/reference/put-counter.md): Updates information about a throttling counter. - [Delete a throttling counter](https://techdocs.akamai.com/key-traffic-mgmt/reference/delete-counter.md): Removes a throttling counter. - [List counter endpoints](https://techdocs.akamai.com/key-traffic-mgmt/reference/get-counter-endpoints.md): Returns information about all endpoints assigned to the contract and group where you created the throttling counter. The [API Endpoints API](https://techdocs.akamai.com/api-definitions/reference/api) manages the format of the response data. Search the response data for the relevant `ACL_ENTRY` members such as API endpoint identifiers, resource identifiers, or HTTP methods, to use when running the [Create a throttling counter](ref:post-counter) or [Edit a throttling counter](ref:put-counter) operation. - [List counter key collections](https://techdocs.akamai.com/key-traffic-mgmt/reference/get-counter-key-collections.md): Returns information about all key collections assigned to the contract and group where you created the throttling counter. Search the response data for the relevant `KEY COLLECTION` identifiers to use when running the [Create a throttling counter](ref:post-counter) or [Edit a throttling counter](ref:put-counter) operation. - [List counter keys](https://techdocs.akamai.com/key-traffic-mgmt/reference/get-counter-keys.md): This lists all API keys assigned to the contract and group where you created the throttling counter. Search the response data for the relevant `KEY` identifier members to use when running the [Create a throttling counter](ref:post-counter) or [Edit a throttling counter](ref:put-counter) operation. - [Create keys](https://techdocs.akamai.com/key-traffic-mgmt/reference/post-keys.md): Creates a collection of keys with unassigned values. To generate keys with assigned values, use the [Generate keys](ref:post-keys-generate) operation. - [List keys](https://techdocs.akamai.com/key-traffic-mgmt/reference/get-keys.md): Returns keys included in a collection based on the specified criteria. - [Assign keys](https://techdocs.akamai.com/key-traffic-mgmt/reference/post-keys-assign.md): Assigns keys to collections. - [Export keys](https://techdocs.akamai.com/key-traffic-mgmt/reference/get-export-keys.md): Returns information about all available keys in the JSON, XML, or CSV format. - [Generate keys](https://techdocs.akamai.com/key-traffic-mgmt/reference/post-keys-generate.md): Creates a collection of keys with assigned values. To create keys and assign your own values, use the [Create keys](ref:post-keys) operation. - [Move keys](https://techdocs.akamai.com/key-traffic-mgmt/reference/post-keys-move.md): "Moves keys from one collection to another, either an existing one or a new one. If you specify a `destinationCollectionId` in the request, the operation moves the keys to the existing collection. \n" - [Restore revoked keys](https://techdocs.akamai.com/key-traffic-mgmt/reference/post-keys-restore.md): Restores previously revoked keys in a collection. This operation is only available in the 120 days following the revocation. - [Revoke keys](https://techdocs.akamai.com/key-traffic-mgmt/reference/post-keys-revoke.md): Revokes keys in a collection and marks them as revoked. You can restore the revoked keys within the next 120 days, after which they're deleted. - [Unassign keys](https://techdocs.akamai.com/key-traffic-mgmt/reference/post-keys-unassign.md): Unassigns keys from collections. - [Get a key](https://techdocs.akamai.com/key-traffic-mgmt/reference/get-key.md): Returns information about a key. - [Edit a key](https://techdocs.akamai.com/key-traffic-mgmt/reference/put-key.md): Updates information about a key. - [Reset key quota](https://techdocs.akamai.com/key-traffic-mgmt/reference/post-keys-quota-reset.md): Resets the quota limit for selected keys. - [List tags](https://techdocs.akamai.com/key-traffic-mgmt/reference/get-tags.md): Returns all existing tags. You can add new tags when creating new keys. See either the [Create keys](ref:post-keys) or [Generate keys](ref:post-keys-generate) operation. ## Recipes - [Create a key collection](https://techdocs.akamai.com/key-traffic-mgmt/recipes/create-a-key-collection-1.md) - [Create a throttling counter](https://techdocs.akamai.com/key-traffic-mgmt/recipes/create-a-throttling-counter-1.md) - [Create keys](https://techdocs.akamai.com/key-traffic-mgmt/recipes/create-keys-1.md) - [Edit an ACL](https://techdocs.akamai.com/key-traffic-mgmt/recipes/edit-an-acl-1.md) - [Edit quota settings](https://techdocs.akamai.com/key-traffic-mgmt/recipes/edit-quota-settings.md) - [Generate keys](https://techdocs.akamai.com/key-traffic-mgmt/recipes/generate-keys-1.md) - [Import keys in the CSV format](https://techdocs.akamai.com/key-traffic-mgmt/recipes/import-keys-in-the-csv-format.md) - [Import keys in the JSON format](https://techdocs.akamai.com/key-traffic-mgmt/recipes/import-keys-in-the-json-format.md) - [Import keys in the XML format](https://techdocs.akamai.com/key-traffic-mgmt/recipes/import-keys-in-the-xml-format.md) - [Move keys to a new collection](https://techdocs.akamai.com/key-traffic-mgmt/recipes/move-keys-to-a-new-collection.md) - [Move keys to an existing collection](https://techdocs.akamai.com/key-traffic-mgmt/recipes/move-keys-to-an-existing-collection.md) - [Restore keys](https://techdocs.akamai.com/key-traffic-mgmt/recipes/restore-keys.md) - [Revoke keys](https://techdocs.akamai.com/key-traffic-mgmt/recipes/revoke-keys.md) ## Changelog - [May 5, 2025 — API Keys and Traffic Management v1 decommissioned](https://techdocs.akamai.com/key-traffic-mgmt/changelog/may-5-2025-api-keys-and-traffic-management-v1-decommissioned.md) - [Dec 4, 2024 — Alert threshold improvements](https://techdocs.akamai.com/key-traffic-mgmt/changelog/dec-4-2024-alert-threshold-improvements.md) - [Jan 31, 2024 — New API Keys and Traffic Management version](https://techdocs.akamai.com/key-traffic-mgmt/changelog/jan-26-2024-new-api-keys-and-traffic-management-version.md) - [Dec 2, 2021 — New API Keys and Traffic Management API documentation experience](https://techdocs.akamai.com/key-traffic-mgmt/changelog/dec-2021-new-api-keys-and-traffic-management-api-documentation-experience.md) # App Platform for LKE Documentation > App Platform is a Kubernetes service that combines developer-centric and operations-centric tooling along with automation and a self-service portal. This streamlines the application life cycle when using Kubernetes, from development to delivery to the management of containerized application workloads. ## Guides - [Welcome to App Platform for LKE](https://techdocs.akamai.com/app-platform/docs/welcome.md) - [Automatic installation on LKE](https://techdocs.akamai.com/app-platform/docs/lke-automatic-install.md) - [Additional installation methods](https://techdocs.akamai.com/app-platform/docs/additional-installation-methods.md) - [Manual installation on LKE](https://techdocs.akamai.com/app-platform/docs/lke-manual-install.md) - [Custom installation on other Kubernetes services](https://techdocs.akamai.com/app-platform/docs/custom.md) - [Supplemental Helm instructions](https://techdocs.akamai.com/app-platform/docs/helm.md) - [Advanced setup configurations](https://techdocs.akamai.com/app-platform/docs/advanced-configuration.md) - [DNS setup](https://techdocs.akamai.com/app-platform/docs/dns.md) - [OIDC setup through Azure Entra ID](https://techdocs.akamai.com/app-platform/docs/oidc.md) - [Install with entrypoint](https://techdocs.akamai.com/app-platform/docs/entrypoint.md) - [BYO wildcard certificate](https://techdocs.akamai.com/app-platform/docs/byo-wildcard-cert.md) - [BYO Git](https://techdocs.akamai.com/app-platform/docs/byo-git.md) - [Post installation steps](https://techdocs.akamai.com/app-platform/docs/post-installation-steps.md) - [Upgrade instructions](https://techdocs.akamai.com/app-platform/docs/upgrade-instructions.md) - [Getting started with App Platform for LKE](https://techdocs.akamai.com/app-platform/docs/getting-started.md) - [App Platform Console (UI)](https://techdocs.akamai.com/app-platform/docs/console-overview.md) - [Platform view and dashboard](https://techdocs.akamai.com/app-platform/docs/console-platform-view.md) - [Team view and dashboard](https://techdocs.akamai.com/app-platform/docs/console-team-overview.md) - [Security best practices](https://techdocs.akamai.com/app-platform/docs/security-best-practices.md) - [GitOps](https://techdocs.akamai.com/app-platform/docs/gitops.md) - [Teams](https://techdocs.akamai.com/app-platform/docs/platform-teams.md) - [Users](https://techdocs.akamai.com/app-platform/docs/platform-user-management.md) - [Apps](https://techdocs.akamai.com/app-platform/docs/manage-apps.md) - [App Catalogs](https://techdocs.akamai.com/app-platform/docs/manage-catalog.md) - [Platform settings](https://techdocs.akamai.com/app-platform/docs/platform-settings.md) - [Cluster settings](https://techdocs.akamai.com/app-platform/docs/cluster-settings.md) - [General platform settings](https://techdocs.akamai.com/app-platform/docs/general-platform-settings.md) - [Alert settings](https://techdocs.akamai.com/app-platform/docs/alert-settings.md) - [OIDC settings](https://techdocs.akamai.com/app-platform/docs/oidc-settings.md) - [Object storage settings](https://techdocs.akamai.com/app-platform/docs/object-storage-settings.md) - [Additional administration tasks](https://techdocs.akamai.com/app-platform/docs/how-to-for-ops.md) - [Platform secrets](https://techdocs.akamai.com/app-platform/docs/secrets.md) - [Manage ingress controllers](https://techdocs.akamai.com/app-platform/docs/ingress-classes.md) - [Maintenance actions](https://techdocs.akamai.com/app-platform/docs/platform-maintenance.md) - [Deploy without installing the App Platform Console or API](https://techdocs.akamai.com/app-platform/docs/core-only.md) - [Clone to a new Kubernetes cluster](https://techdocs.akamai.com/app-platform/docs/clone-apl.md) - [Manage Age encryption for development, security, and recovery](https://techdocs.akamai.com/app-platform/docs/manage-age.md) - [Change the otomi-admin password](https://techdocs.akamai.com/app-platform/docs/change-admin-password.md) - [Add owner to team organization in Gitea](https://techdocs.akamai.com/app-platform/docs/add-owner-to-team-org-gitea.md) - [Disaster recovery](https://techdocs.akamai.com/app-platform/docs/disaster-recovery.md) - [Basic disaster recovery scenario](https://techdocs.akamai.com/app-platform/docs/basic.md) - [Gitea repositories and database](https://techdocs.akamai.com/app-platform/docs/gitea.md) - [Reinstalling the platform](https://techdocs.akamai.com/app-platform/docs/reinstall.md) - [Restoring platform databases](https://techdocs.akamai.com/app-platform/docs/restore-platform-databases.md) - [Known Issues](https://techdocs.akamai.com/app-platform/docs/known-issues.md) - [Apps](https://techdocs.akamai.com/app-platform/docs/apps.md) - [Catalog](https://techdocs.akamai.com/app-platform/docs/team-catalog.md) - [Code repositories](https://techdocs.akamai.com/app-platform/docs/code-repositories.md) - [Container images](https://techdocs.akamai.com/app-platform/docs/team-container-images.md) - [Secrets](https://techdocs.akamai.com/app-platform/docs/team-secrets.md) - [Workloads](https://techdocs.akamai.com/app-platform/docs/team-workloads.md) - [Network policies](https://techdocs.akamai.com/app-platform/docs/team-network-policies.md) - [Services](https://techdocs.akamai.com/app-platform/docs/team-services.md) - [Security policies](https://techdocs.akamai.com/app-platform/docs/team-security-policies.md) - [Team Settings](https://techdocs.akamai.com/app-platform/docs/team-settings.md) - [Shell (TTY Console)](https://techdocs.akamai.com/app-platform/docs/shell-tty.md) - [Getting started with labs](https://techdocs.akamai.com/app-platform/docs/labs-overview.md) - [Create code repositories and images](https://techdocs.akamai.com/app-platform/docs/create-code-repositories-and-images.md) - [Create code repositories](https://techdocs.akamai.com/app-platform/docs/create-repos.md) - [Register code repositories](https://techdocs.akamai.com/app-platform/docs/register-repos.md) - [Create container images](https://techdocs.akamai.com/app-platform/docs/create-images.md) - [Trigger builds](https://techdocs.akamai.com/app-platform/docs/trigger-builds.md) - [Push images to Harbor](https://techdocs.akamai.com/app-platform/docs/push-images.md) - [Create workloads](https://techdocs.akamai.com/app-platform/docs/create-workloads-with-argocd.md) - [Create Secrets](https://techdocs.akamai.com/app-platform/docs/create-secrets.md) - [Use the Catalog](https://techdocs.akamai.com/app-platform/docs/use-catalog.md) - [Create workloads](https://techdocs.akamai.com/app-platform/docs/create-workloads.md) - [Configure auto image updater](https://techdocs.akamai.com/app-platform/docs/auto-image-update.md) - [Create a PostgreSQL database](https://techdocs.akamai.com/app-platform/docs/create-postgresql-db.md) - [Publicly expose workloads](https://techdocs.akamai.com/app-platform/docs/expose-services.md) - [Secure workloads](https://techdocs.akamai.com/app-platform/docs/secure-workloads.md) - [Scan your images for vulnerabilities](https://techdocs.akamai.com/app-platform/docs/scan-images.md) - [Scan your running containers for vulnerabilities](https://techdocs.akamai.com/app-platform/docs/scan-containers.md) - [Monitor and debug workloads](https://techdocs.akamai.com/app-platform/docs/monitor-and-debug-workloads.md) - [View container logs](https://techdocs.akamai.com/app-platform/docs/view-logs.md) - [View container metrics](https://techdocs.akamai.com/app-platform/docs/view-metrics.md) - [Using custom metrics](https://techdocs.akamai.com/app-platform/docs/custom-metrics.md) - [Monitoring service availability](https://techdocs.akamai.com/app-platform/docs/monitor-services.md) - [Advanced labs](https://techdocs.akamai.com/app-platform/docs/advanced-labs.md) - [Create network policies](https://techdocs.akamai.com/app-platform/docs/create-netpols.md) - [OpenTelemetry](https://techdocs.akamai.com/app-platform/docs/use-otel.md) - [Canary deployment](https://techdocs.akamai.com/app-platform/docs/canary-deployment.md) - [Create a RabbitMQ cluster](https://techdocs.akamai.com/app-platform/docs/create-rabbitmq-cluster.md) - [Use a Git client with Gitea](https://techdocs.akamai.com/app-platform/docs/using-git-client.md) - [Configuring a CNAME](https://techdocs.akamai.com/app-platform/docs/configure-cname.md) ## Changelog - [May 1, 2026 — App Platform v5.0.0](https://techdocs.akamai.com/app-platform/changelog/v5-0-0.md) - [Mar 23, 2026 — App Platform v4.15.1](https://techdocs.akamai.com/app-platform/changelog/v4-15-1.md) - [Feb 24, 2026 — App Platform v4.14.0](https://techdocs.akamai.com/app-platform/changelog/v4-14-0.md) - [Jan 19, 2026 — App Platform v4.13.0](https://techdocs.akamai.com/app-platform/changelog/v4-13-0.md) - [Oct 30, 2025 — App Platform v4.12.0](https://techdocs.akamai.com/app-platform/changelog/v4-12-0.md) # Application Security API Documentation > Akamai's Application Security API allows you to access and modify your Security Configurations for Kona Site Defender, Web Application Protector, App & API Protector, Advanced Security Module, and Client Reputation. You can create, update, activate, and export versions of a security configuration. You can get selectable hostnames and add them to the selected list to protect your website or API content. You also can add, modify, or delete custom rules and assign policy actions. ## API Reference - [Application Security API](https://techdocs.akamai.com/application-security/reference/api.md) - [API summary](https://techdocs.akamai.com/application-security/reference/api-summary.md) - [Get Started](https://techdocs.akamai.com/application-security/reference/getting-started.md) - [API concepts](https://techdocs.akamai.com/application-security/reference/api-concepts.md) - [API workflows](https://techdocs.akamai.com/application-security/reference/api-workflow.md) - [Activate with invalid hostnames](https://techdocs.akamai.com/application-security/reference/activate-with-invalid-hostnames.md) - [Add a new hostname to a configuration](https://techdocs.akamai.com/application-security/reference/modify-and-activate-a-config-version.md): This workflow shows you how to make changes to a configuration version including adding new hostnames, and then activating the changes you've made. - [Add a new custom rule to a configuration](https://techdocs.akamai.com/application-security/reference/add-a-new-custom-rule-to-a-configuration.md): These steps show you how to modify a configuration, add a new custom rule, and activate the new configuration version. - [Export a configuration version](https://techdocs.akamai.com/application-security/reference/export-a-configuration-version.md) - [Diff configuration versions](https://techdocs.akamai.com/application-security/reference/diff-configuration-versions.md) - [Rate limiting](https://techdocs.akamai.com/application-security/reference/rate-limiting.md) - [Export condition type values](https://techdocs.akamai.com/application-security/reference/etval.md) - [Export match condition type values](https://techdocs.akamai.com/application-security/reference/cndval.md) - [Export header values](https://techdocs.akamai.com/application-security/reference/hdval.md) - [Condition values](https://techdocs.akamai.com/application-security/reference/condition-values.md) - [CustomRule condition type values](https://techdocs.akamai.com/application-security/reference/condition-type-values.md) - [Deny name values](https://techdocs.akamai.com/application-security/reference/deny-name-values.md) - [Exception selector values](https://techdocs.akamai.com/application-security/reference/exception-selector-values.md) - [Recommendation selector values](https://techdocs.akamai.com/application-security/reference/recommendation-selector-values.md) - [Logging option values (Beta)](https://techdocs.akamai.com/application-security/reference/logging-option-values.md) - [SIEM action and attack-type exceptions](https://techdocs.akamai.com/application-security/reference/siem-action-and-attack-type-exceptions.md) - [Errors](https://techdocs.akamai.com/application-security/reference/api-errors.md) - [400](https://techdocs.akamai.com/application-security/reference/400.md) - [401](https://techdocs.akamai.com/application-security/reference/401.md) - [403](https://techdocs.akamai.com/application-security/reference/403.md) - [404](https://techdocs.akamai.com/application-security/reference/404.md) - [409](https://techdocs.akamai.com/application-security/reference/409.md) - [429](https://techdocs.akamai.com/application-security/reference/429.md) - [Create a configuration](https://techdocs.akamai.com/application-security/reference/post-config.md): __All products__ Create a new WAP or KSD security configuration. KSD security configurations start out empty, and WAP configurations are created with preset values. The contract you pass in the request body determines which product you use. You can edit the default settings included in the WAP configuration, but you'll need to run additional operations in this API to select specific protections for KSD. Your KSD configuration needs match targets and protection settings before you activate. - [List configurations](https://techdocs.akamai.com/application-security/reference/get-configs.md): __All products__ Lists available security configurations. - [Get a security configuration](https://techdocs.akamai.com/application-security/reference/get-config.md): __All products__ Retrieves the configuration details. - [Rename a security configuration](https://techdocs.akamai.com/application-security/reference/put-config.md): __All products__ Update the name of your security configuration. - [Delete a configuration](https://techdocs.akamai.com/application-security/reference/delete-config.md): __All products__ Deletes the specified security configuration. - [Clone a configuration version](https://techdocs.akamai.com/application-security/reference/post-config-versions.md): __All products__ Creates a new version of the specified security configuration. - [List configuration versions](https://techdocs.akamai.com/application-security/reference/get-config-versions.md): __All products__ Lists available versions for the specified security configuration, with results optionally paginated. - [Get configuration version details](https://techdocs.akamai.com/application-security/reference/get-version-number.md): __All products__ Returns basic details about a configuration version. To get a more extensive object with detailed information about a version's security policies, rate policies, rules, and other additional settings, run the [Export a configuration version](ref:get-export-config-version) operation. - [Delete a configuration version](https://techdocs.akamai.com/application-security/reference/delete-version-number.md): __All products__ Delete the specified configuration version. You can't delete a version that's actively in use. - [Get the version notes](https://techdocs.akamai.com/application-security/reference/get-version-notes.md): __All products__ Get the most recent version notes for a configuration. - [Modify version notes](https://techdocs.akamai.com/application-security/reference/put-version-notes.md): __All products__ Update the most recent version notes for a configuration. - [Get the hostname coverage match targets](https://techdocs.akamai.com/application-security/reference/get-coverage-match-targets.md): __Kona Site Defender__, __App & API Protector with the Advanced Security module__ List the API and website match targets that protect a hostname. - [Create a match target](https://techdocs.akamai.com/application-security/reference/post-match-targets.md): __Kona Site Defender__, __App & API Protector with the Advanced Security module__ Creates a new Match Target in the specified Configuration Version. - [List match targets](https://techdocs.akamai.com/application-security/reference/get-match-targets.md): __Kona Site Defender__, __App & API Protector with the Advanced Security module__ Returns match targets defined in the specified security configuration version. - [Modify match target order](https://techdocs.akamai.com/application-security/reference/put-match-targets-sequence.md): __Kona Site Defender__, __App & API Protector with the Advanced Security module__ Updates the sequence of Match Targets in a configuration version. The `website` and `api` match targets' sequence requires updates from separate requests by passing the `type` attribute in the JSON request. - [Get a match target](https://techdocs.akamai.com/application-security/reference/get-match-target.md): __Kona Site Defender__, __App & API Protector with the Advanced Security module__ Returns the specified match target. - [Modify a match target](https://techdocs.akamai.com/application-security/reference/put-match-target.md): __Kona Site Defender__, __App & API Protector with the Advanced Security module__ Updates details about the specified match target. - [Remove a match target](https://techdocs.akamai.com/application-security/reference/delete-match-target.md): __Kona Site Defender__, __App & API Protector with the Advanced Security module__ Deletes the specified match target. - [Get prefetch requests](https://techdocs.akamai.com/application-security/reference/get-advanced-settings-prefetch.md): __Kona Site Defender__ Get Prefetch Request settings. - [Modify prefetch requests](https://techdocs.akamai.com/application-security/reference/put-advanced-settings-prefetch.md): __Kona Site Defender__ Enabling this protection causes your application firewall rules to inspect internal requests (those between your origin and Akamai's servers) for file types you specify. You can also apply rate controls to prefetch requests. This operation applies at the configuration level. - [Create a rate policy](https://techdocs.akamai.com/application-security/reference/post-rate-policies.md): __All products__ Create a new rate policy for a specific configuration version. Now you can match on defined or undefined resources. If you're setting a match for either resource type, both `definedResources` and `undefinedResources` must be present in the request object or the request is considered incomplete. When `true`, match on _any_ defined resources without passing a `resourceId`. When `false`, you'll need to pass a `resourceId`. If you pass `definedResources` and `undefinedResources` with empty values, they default to `false`. You can omit both resources and use this operation without these new match criteria. Contact your account team if you'd like to match on `definedResources` or `undefinedResources`. - [List rate policies](https://techdocs.akamai.com/application-security/reference/get-rate-policies.md): __All products__ Returns rate policies for a specific security configuration version. - [Get a rate policy](https://techdocs.akamai.com/application-security/reference/get-rate-policy.md): __All products__ Returns the specified rate policy. - [Modify a rate policy](https://techdocs.akamai.com/application-security/reference/put-rate-policy.md): __All products__ Update details for a specific rate policy. Now you can match on defined or undefined resources. If you're setting a match for either resource type, both `definedResources` and `undefinedResources` must be present in the request object or the request is considered incomplete. When `true`, match on _any_ defined resources without passing a `resourceId`. When `false`, you'll need to pass a `resourceId`. If you pass `definedResources` and `undefinedResources` with empty values, they default to `false`. You can omit both resources and use this operation without these new match criteria. Contact your account team if you'd like to match on `definedResources` or `undefinedResources`. - [Remove a rate policy](https://techdocs.akamai.com/application-security/reference/delete-rate-policy.md): __All products__ Delete the specified rate policy. You can't delete a rate policy that is actively in use. To delete the rate policy, first activate an older configuration version or create a new version without the policy in place. - [Modify a rate policy evaluation](https://techdocs.akamai.com/application-security/reference/put-rate-policy-evaluation.md): __All products__ Apply or discard a rate policy evaluation. - [Get SIEM settings](https://techdocs.akamai.com/application-security/reference/get-siem.md): __All products__ Return SIEM settings for a specific configuration. - [Modify SIEM settings](https://techdocs.akamai.com/application-security/reference/put-siem.md): __All products__ Update SIEM settings for a specific configuration. - [Get SIEM versions](https://techdocs.akamai.com/application-security/reference/get-siem-definitions.md): __All products__ Get available SIEM versions. - [Create a URL protection policy](https://techdocs.akamai.com/application-security/reference/post-url-protection-policies.md): __All products__ Creates a new URL protection policy for a specific configuration version. - [List URL protection policies](https://techdocs.akamai.com/application-security/reference/get-url-protection-policies.md): __All products__ Returns all URL protection policies for a specific security configuration version. - [Get a URL protection policy](https://techdocs.akamai.com/application-security/reference/get-url-protection-policy.md): __All products__ Returns the specified URL protection policy. - [Modify a URL protection policy](https://techdocs.akamai.com/application-security/reference/put-url-protection-policy.md): __All products__ Updates the specified URL protection policy. - [Remove a URL protection policy](https://techdocs.akamai.com/application-security/reference/delete-url-protection-policy.md): __All products__ Deletes the specified URL protection policy. You can't delete a URL protection policy that's actively in use. To delete an active URL protection policy, either activate an older configuration version or create a new version without the policy in place. - [List hostname overlaps](https://techdocs.akamai.com/application-security/reference/get-hostname-coverage-overlapping.md): __Kona Site Defender__, __App & API Protector with the Advanced Security module__ List the configuration versions that contain a hostname also included in the current configuration version. - [List selectable hostnames](https://techdocs.akamai.com/application-security/reference/get-selectable-hostnames.md): __All products__ List the hostnames that a given configuration version has the ability to protect. Hostnames may show as error hosts when they aren't currently available. For example, when a contract expires. - [List selected hostnames](https://techdocs.akamai.com/application-security/reference/get-selected-hostnames.md): __All products__ List the hostnames that the configuration version selects as candidates of protected hostnames, which you can use in match targets. - [Modify selected hostnames](https://techdocs.akamai.com/application-security/reference/put-selected-hostnames.md): __All products__ Update the list of selected hostnames for a configuration version. Now you can add an individual hostname to your selected hostnames list without passing the entire list plus the new hostname in this PUT object. Previously, you needed to pass every hostname in the PUT object or any hostnames not included would be deleted from the list. - [Create a malware policy](https://techdocs.akamai.com/application-security/reference/post-malware-policies.md): __All products__ Create a new malware policy for a security configuration version. - [List malware policies](https://techdocs.akamai.com/application-security/reference/get-malware-policies.md): __All products__ Return malware policies for a security configuration version. - [List supported malware policy content types](https://techdocs.akamai.com/application-security/reference/get-malware-policy-content-types.md): __All products__ Returns all the supported malware policy content types for a security configuration version. - [Get a malware policy](https://techdocs.akamai.com/application-security/reference/get-malware-policy.md): __All products__ Return a malware policy. - [Modify a malware policy](https://techdocs.akamai.com/application-security/reference/put-malware-policy.md): __All products__ Update details for a malware policy. - [Remove a malware policy](https://techdocs.akamai.com/application-security/reference/delete-malware-policy.md): __All products__ Delete a specific malware policy that's not actively in use. To delete an active malware policy, first activate an older configuration version or create a new version without the policy in place. - [Create a custom rule](https://techdocs.akamai.com/application-security/reference/post-config-custom-rules.md): __All products__ Creates a new custom rule. - [List custom rules](https://techdocs.akamai.com/application-security/reference/get-configs-custom-rules.md): __All products__ Lists custom rules defined in a security configuration. - [Get a custom rule](https://techdocs.akamai.com/application-security/reference/get-config-custom-rule.md): __All products__ Returns the details of a custom rule. - [Modify a custom rule](https://techdocs.akamai.com/application-security/reference/put-config-custom-rule.md): __All products__ Updates an existing custom rule. - [Remove a custom rule](https://techdocs.akamai.com/application-security/reference/delete-config-custom-rule.md): __All products__ Deletes a custom rule as long as it isn't activated. - [List custom rules usage by security policies](https://techdocs.akamai.com/application-security/reference/post-config-custom-rules-usage.md): __All products__ Returns a list of security policies using each requested custom rule with a set action (Allow or Deny), if any apply. Skips custom rule IDs that do not belong to this security configuration. - [Get PII learning settings for a configuration](https://techdocs.akamai.com/application-security/reference/get-advanced-settings-pii-learning.md): __Kona Site Defender__, __App & API Protector with the Advanced Security module__ Shows whether PII learning is enabled. This operation applies at the security configuration level. - [Enable PII learning settings for a configuration](https://techdocs.akamai.com/application-security/reference/put-advanced-settings-pii-learning.md): __Kona Site Defender__, __App & API Protector with the Advanced Security module__ Turn on PII learning for your API definition. To enable PII learning, submit your request with a payload of `{"enablePiiLearning": true}`. To disable PII learning, submit your request with a payload of `{"enablePiiLearning": false}`. This operation applies at the security configuration level. Run [Modify PII settings for an endpoint version](https://techdocs.akamai.com/api-definitions/reference/post-endpoint-version-pii-settings) to manage your API definitions in regards to PII. - [Create a custom deny action](https://techdocs.akamai.com/application-security/reference/post-custom-deny.md): __All products__ Create a new custom deny action for a specific configuration version. - [List custom deny actions](https://techdocs.akamai.com/application-security/reference/get-custom-deny-actions.md): __All products__ Returns custom deny actions for a specific security configuration version. - [Get a custom deny action](https://techdocs.akamai.com/application-security/reference/get-custom-deny-action.md): __All products__ Returns the specified custom deny action. - [Modify a custom deny action](https://techdocs.akamai.com/application-security/reference/put-custom-deny.md): __All products__ Update details for a specific custom deny action. - [Remove a custom deny action](https://techdocs.akamai.com/application-security/reference/delete-custom-deny.md): __All products__ Delete a custom deny action. You can't delete a custom deny action that is actively in use. To delete the custom deny action, first activate an older configuration version or create a new version without the policy in place. - [Get bypass network lists settings](https://techdocs.akamai.com/application-security/reference/get-bypass-network-lists.md): __Web Application Protector__ Lists which network lists are used in the bypass network lists settings. If you want to add or remove IP addresses from the network lists, use the [Network Lists API](https://techdocs.akamai.com/network-lists/reference/api). - [Modify the bypass network lists settings](https://techdocs.akamai.com/application-security/reference/put-bypass-network-lists.md): __Web Application Protector__ Update which network lists to use in the bypass network lists settings. If you want to add or remove IP addresses from the network lists, use the [Network Lists API](https://techdocs.akamai.com/network-lists/reference/api). - [List failover hostnames](https://techdocs.akamai.com/application-security/reference/get-failover-hostnames.md): __All products__ Get a list of the failover hostnames in a configuration. - [Create a reputation profile](https://techdocs.akamai.com/application-security/reference/post-reputation-profiles.md): __Kona Site Defender__, __App & API Protector with the Advanced Security module__ Create a new reputation profile for a specific configuration version. - [List reputation profiles](https://techdocs.akamai.com/application-security/reference/get-reputation-profiles.md): __Kona Site Defender__, __App & API Protector with the Advanced Security module__ Returns reputation profiles for a specific security configuration version. To use reputation profiles, you need to add [Client Reputation](https://techdocs.akamai.com/app-api-protector/docs/control-client-reputation) to Kona Site Defender on your contract. - [Get a reputation profile](https://techdocs.akamai.com/application-security/reference/get-reputation-profile.md): __Kona Site Defender__, __App & API Protector with the Advanced Security module__ Returns the details for a specific reputation profile. - [Modify a reputation profile](https://techdocs.akamai.com/application-security/reference/put-reputation-profile.md): __Kona Site Defender__, __App & API Protector with the Advanced Security module__ Update details for a specific reputation profile. - [Remove a reputation profile](https://techdocs.akamai.com/application-security/reference/delete-reputation-profile.md): __Kona Site Defender__, __App & API Protector with the Advanced Security module__ Delete a reputation profile. You can't delete a reputation profile that is actively in use. To delete the reputation profile, first activate an older configuration version or create a new version without that policy in place. - [Get request body size settings for a configuration](https://techdocs.akamai.com/application-security/reference/get-advanced-settings-request-body.md): __All products__ Return request body inspection limit settings for a configuration. Contact your account team if you'd like to run this operation. - [Modify request body inspection limit settings for a configuration](https://techdocs.akamai.com/application-security/reference/put-advanced-settings-request-body.md): __All products__ Modify request body inspection limit settings for a configuration. Inspect request bodies up to a certain size. In exceptional cases, you can change the default value to a set limit: `8`, `16`, or `32` kb. Contact your account team if you'd like to run this operation. - [Get evasive path match settings for a configuration](https://techdocs.akamai.com/application-security/reference/get-evasive-path-match-per-config.md): __Deprecated__, __Web Application Protector__, __Kona Site Defender__ Lists the evasive path match setting for a configuration. Evasive path match is off by default. This setting applies at the configuration level and applies to all policies within a configuration. If you want to view this setting for a specific policy, run [Get evasive patch match settings](ref:get-evasive-path-match). - [Modify evasive path match settings for a configuration](https://techdocs.akamai.com/application-security/reference/put-evasive-path-match-per-config.md): __Deprecated__, __Web Application Protector__, __Kona Site Defender__ This operation enables, disables, or updates evasive path match settings for a configuration. It applies at the configuration level to all its policies. If you want to override these settings for a specific policy, run [Modify evasive path match settings](ref:put-evasive-path-match). - [Get URL evasion defense settings](https://techdocs.akamai.com/application-security/reference/get-url-evasion-defense.md): __Web Application Protector__, __Kona Site Defender__ Lists the URL evasion defense settings for a configuration. URL evasion defense is off by default. - [Modify URL evasion defense settings](https://techdocs.akamai.com/application-security/reference/put-url-evasion-defense.md): __Web Application Protector__, __Kona Site Defender__ This operation enables, disables, or updates URL evasion defense settings for a configuration. - [Get cookie settings](https://techdocs.akamai.com/application-security/reference/get-advanced-settings-cookie-settings.md): __All products__ Returns cookie settings for a configuration. Contact your account team if you'd like to run this operation. - [Modify cookie settings](https://techdocs.akamai.com/application-security/reference/put-advanced-settings-cookie-settings.md): __All products__ Modify cookie settings for a configuration. Contact your account team if you'd like to run this operation. - [Get JA4 client TLS fingerprint settings](https://techdocs.akamai.com/application-security/reference/get-ja4-fingerprint-settings.md): __Beta__, __Web Application Protector__, __Kona Site Defender__ Return JA4 client TLS fingerprint settings for a configuration. JA4 is a client-focused fingerprint based on the client TLS handshake. Use JA4 fingerprinting to mitigate DDoS attacks, detect and mitigate bots, and block known attackers from sending application layer attacks payloads. [Learn more about JA4 fingerprinting]( https://techdocs.akamai.com/app-api-protector/docs/adv-settings). - [Modify JA4 client TLS fingerprint settings](https://techdocs.akamai.com/application-security/reference/put-ja4-fingerprint-settings.md): __Beta__, __Web Application Protector__, __Kona Site Defender__ Update JA4 client TLS fingerprint settings for a configuration. - [Get the HTTP header log settings for a configuration](https://techdocs.akamai.com/application-security/reference/get-advanced-settings-logging.md): __All products__ Lists HTTP header logging controls for a configuration. HTTP header logging is on by default, and in most cases you should leave it enabled. You can filter requests by header type, including or excluding requests with a specific header, or by cookie. This operation applies at the configuration level, and therefore applies to all policies within a configuration. If you want to view these settings for a specific policy, run [Get HTTP header log settings](ref:get-policies-logging). - [Modify HTTP header log settings for a configuration](https://techdocs.akamai.com/application-security/reference/put-advanced-settings-logging.md): __All products__ Enable, disable, or update HTTP header Logging settings for a configuration. This operation applies at the configuration level, and therefore applies to all policies within a configuration. If you want to override these settings for a specific policy, run [Modify HTTP header log settings](ref:put-policies-logging). - [Get the attack payload log settings for a configuration](https://techdocs.akamai.com/application-security/reference/get-advanced-settings-attack-payload-logging.md): __All products__ Lists attack payload log settings for a configuration. When set to `NONE`, the request body and response body show as redacted in the log. For example, `JSON_PAIRS:redacted`. Attack payload logging is on by default, and in most cases you should leave it enabled. This operation applies at the configuration level, and therefore applies to all policies within a configuration. If you want to view these settings for a specific policy, run [Get attack payload logging settings for a policy](ref:get-policies-attack-payload-logging). - [Modify attack payload log settings for a configuration](https://techdocs.akamai.com/application-security/reference/put-advanced-settings-attack-payload-logging.md): __All products__ Enable, disable, or update attack payload log settings for a configuration. When set to `NONE`, the request body and response body show as redacted in the log. For example, `JSON_PAIRS:redacted`. When set to `RESPONSE_BODY` or `REQUEST_BODY` the log shows only the string flagged as a possible attack, and not the entire request or response body. This operation applies at the configuration level, and therefore applies to all policies within a configuration. If you want to override these settings for a specific policy, run [Modify attack payload log settings for a policy](ref:put-policies-attack-payload-logging). - [Get Pragma settings for a configuration](https://techdocs.akamai.com/application-security/reference/get-advanced-settings-pragma-header.md): __All products__ Return the `Pragma` header excluded conditions. By default, the `Pragma` header is stripped from an operation's response except in cases where you set `excludeCondition`. This operation applies at the security configuration level. To see settings at the security policy level, run [List Pragma header settings for a security policy](ref:get-policies-pragma-header). - [Modify Pragma settings for a configuration](https://techdocs.akamai.com/application-security/reference/put-advanced-settings-pragma-header.md): __All products__ Update the `Pragma` header excluded conditions. By default, the `Pragma` header is stripped from an operation's response except in cases where you set `excludeCondition`. To remove existing settings, submit your request with an empty payload `{}` at the top-level of an object. For example, submit `"type": "{}"` in the request body to remove the `requestHeaderValueMatch` from the excluded conditions. If you submit an empty payload for each field, you'll clear all of your condition settings. This operation applies at the security configuration level. To see settings at the security policy level, run [Modify Pragma header settings for a security policy](ref:put-policies-pragma-header). - [Create a Behavioral DDoS profile](https://techdocs.akamai.com/application-security/reference/post-behavioral-ddos-profile.md): Creates a new Behavioral DDoS profile for a specific configuration version. _Products:_ All. - [List Behavioral DDoS profiles](https://techdocs.akamai.com/application-security/reference/get-behavioral-ddos-profiles.md): Returns all Behavioral DDoS profiles for a specific security configuration version. _Products:_ All. - [Remove a Behavioral DDoS profile](https://techdocs.akamai.com/application-security/reference/delete-behavioral-ddos-profile.md): Deletes the specified Behavioral DDoS profile. You can't delete a Behavioral DDoS profile that's actively in use. To delete an active Behavioral DDoS profile, either activate an older configuration version or create a new version without the policy in place. _Products:_ All. - [Get a Behavioral DDoS profile](https://techdocs.akamai.com/application-security/reference/get-behavioral-ddos-profile.md): Returns the specified Behavioral DDoS profile. _Products:_ All. - [Modify a Behavioral DDoS profile](https://techdocs.akamai.com/application-security/reference/put-behavioral-ddos-profile.md): Updates the specified Behavioral DDoS profile. _Products:_ All. - [Clone or create a security policy](https://techdocs.akamai.com/application-security/reference/post-policy.md): __Kona Site Defender__, __App & API Protector with the Advanced Security module__ Creates a new copy of an existing security policy or creates a new security policy from scratch when you don't specify a policy to clone in the request. To create a new security policy, leave `createFromSecurityPolicy` empty in your request. - [List security policies](https://techdocs.akamai.com/application-security/reference/get-policies.md): __All products__ Returns a list of security policies available for the specified security configuration. - [Get a security policy](https://techdocs.akamai.com/application-security/reference/get-policy.md): __All products__ Returns the specified security policy. - [Modify a security policy](https://techdocs.akamai.com/application-security/reference/put-policy.md): __All products__ Update the name of a specific security policy. Currently, you can only edit a security policy's name with this operation, although other editable fields will be available in the future. For any changes to settings within a security policy, run the modify operation for that specific setting. For example, to update your IP/Geo settings, run [Update IP/Geo Firewall settings](ref:put-policy-ip-geo-firewall). - [Remove a security policy](https://techdocs.akamai.com/application-security/reference/delete-policy.md): __Kona Site Defender__, __App & API Protector with the Advanced Security module__ Delete the specified security policy. You can't delete a security policy that is actively in use. Before you run this operation, create a new version of your security configuration and omit the policy you want to delete. Once you have activated your new configuration version, you can delete the security policy you omitted from the new version. One way to create a new configuration quickly is to run [Clone a configuration version](ref:post-config-versions), remove the policy you want to delete, then PUT the edited object back to [Modify a security policy](ref:put-policy). - [List rate policy actions](https://techdocs.akamai.com/application-security/reference/get-rate-policies-actions.md): __All products__ Returns a list of all rate policies currently in use with the actions each policy takes when conditions are met. - [Modify a rate policy action](https://techdocs.akamai.com/application-security/reference/put-rate-policy-action.md): __All products__ Updates the actions in a rate policy. - [Get IP/Geo Firewall settings](https://techdocs.akamai.com/application-security/reference/get-policy-ip-geo-firewall.md): __All products__ Lists which network lists are used in the IP/Geo Firewall settings. In Control Center this method is called `mode`. In this API the method is called `blocked`. The response shows blocked and allowed IPs depending on which network lists you include and which version of the mode you choose. If you want to add or remove IP addresses from the network lists, use the [Network Lists API](https://techdocs.akamai.com/network-lists/reference/api). Note that subnet controls are a legacy item in Control Center and are not available through this API. - [Modify IP/Geo Firewall settings](https://techdocs.akamai.com/application-security/reference/put-policy-ip-geo-firewall.md): __All products__ Update the method and which network lists to use for IP/Geo firewall blocking. In Control Center this method is called `mode`. In this API the method is called `blocked`. Use `blockSpecificIPGeo` to block any IPs, geographies, or network lists you choose with this setting. Use `blockAllTrafficExceptAllowedIPs` to allow specific IPs or geographies that you choose to let through while the rest remain blocked. IPs you want to allow are contained in the `allowedIPNetworkLists`. It's important to verify the IPs you block are the ones you intend to block as it's easy to block wanted traffic by accident. Note that subnet controls are a legacy item in Control Center and are not available through this API. - [Get attack payload logging settings for a policy](https://techdocs.akamai.com/application-security/reference/get-policies-attack-payload-logging.md): __All products__ List a security policy's settings for attack payload logging. Attack payload logging is on by default, and in most cases you should leave it enabled. When set to `NONE`, the request body and response body appear as `redacted` in the log. For example, `JSON_PAIRS:redacted`. This operation applies at the security policy level, and overrides the attack payload logging settings at the configuration level on a per-policy basis. - [Modify attack payload logging settings for a policy](https://techdocs.akamai.com/application-security/reference/put-policies-attack-payload-logging.md): __All products__ Update attack payload logging settings for a specific policy. This operation applies at the security policy level, and overrides the attack payload logging settings at the configuration level on a per-policy basis. When set to `NONE`, the request body and response body appear as `redacted` in the log. For example, `JSON_PAIRS:redacted`. - [Get HTTP header log settings](https://techdocs.akamai.com/application-security/reference/get-policies-logging.md): __All products__ List a security policy's settings for HTTP header logging. HTTP header logging is on by default, and in most cases you should leave it enabled. You can filter requests by header type, including or excluding requests with a specific header, or by cookie. This operation applies at the security policy level, and overrides the HTTP header log settings at the configuration level on a per-policy basis. - [Modify HTTP header log settings](https://techdocs.akamai.com/application-security/reference/put-policies-logging.md): __All products__ Enable, disable, or update HTTP header logging settings for a specific policy. This operation applies at the security policy level, and overrides the HTTP header log settings at the configuration level on a per-policy basis. - [List reputation profile actions](https://techdocs.akamai.com/application-security/reference/get-reputation-profiles-actions.md): __Kona Site Defender__, __App & API Protector with the Advanced Security module__ Return a list of reputation profiles with their associated actions. - [Get the action for a reputation profile](https://techdocs.akamai.com/application-security/reference/get-reputation-profile-action.md): __Kona Site Defender__, __App & API Protector with the Advanced Security module__ Return the action a reputation profile takes when triggered. - [Modify the action for a reputation profile](https://techdocs.akamai.com/application-security/reference/put-reputation-profile-action.md): __Kona Site Defender__, __App & API Protector with the Advanced Security module__ Update what action to take when reputation profile's rule triggers. Use `alert` to record the trigger of the event, `deny` to block the request, or `none` to take no action. Currently the only field in the reputation profile object is `action`. - [List custom rule actions](https://techdocs.akamai.com/application-security/reference/get-custom-rules.md): __All products__ Returns a list of all configured custom rules for the specified configuration. It includes information for rules that are associated with this policy, as well as the latest versions of the rules in the configuration that aren't associated with the current policy. Unassociated rules have an action of `none`. - [Modify a custom rule action](https://techdocs.akamai.com/application-security/reference/put-custom-rule.md): __All products__ Updates the action of a custom rule. - [Get reputation analysis settings](https://techdocs.akamai.com/application-security/reference/get-reputation-analysis.md): __Kona Site Defender__ Return the current reputation analysis settings. - [Modify reputation analysis settings](https://techdocs.akamai.com/application-security/reference/put-reputation-analysis.md): __Kona Site Defender__ Toggle the `forwardToHTTPHeader` and `forwardSharedIPToHTTPHeaderAndSIEM` options. The `forwardToHTTPHeader` option adds client reputation details to requests forwarded to origin in an HTTP header. The `forwardSharedIPToHTTPHeaderAndSIEM` option adds a value indicating that shared IPs are included in HTTP header and SIEM integration when used. - [List URL protection policy actions](https://techdocs.akamai.com/application-security/reference/get-url-protection-policies-actions.md): __All products__ Returns a list of all URL protection policies currently in use, along with the actions each policy takes when conditions are met. - [Modify a URL protection policy action](https://techdocs.akamai.com/application-security/reference/put-url-protection-policy-action.md): __All products__ Updates the actions in a URL protection policy. - [Get Pragma settings for a security policy](https://techdocs.akamai.com/application-security/reference/get-policies-pragma-header.md): __All products__ Return the `Pragma` header's excluded conditions. By default, the `Pragma` header debugging information is stripped from an operation's response except in cases where you set `excludeCondition`. This operation applies at the security policy level. To modify `Pragma` header settings at the security configuration level, run [List Pragma header settings for a configuration](ref:get-advanced-settings-pragma-header). - [Modify Pragma settings for a security policy](https://techdocs.akamai.com/application-security/reference/put-policies-pragma-header.md): __All products__ Update the pragma header excluded conditions. By default, the `Pragma` header debugging information is stripped from an operation's response except in cases where you set `excludeCondition`. To remove existing settings, submit your request with an empty payload `{}` at the top-level of an object. For example, submit `"type": "{}"` in the request body to remove the `requestHeaderValueMatch` from the excluded conditions. If you submit an empty payload for each field, you'll clear all of your condition settings. To modify `Pragma` header settings at the security configuration level, run [Modify Pragma header settings for a configuration](ref:put-advanced-settings-pragma-header) . - [List API request constraints and actions](https://techdocs.akamai.com/application-security/reference/get-api-request-constraints.md): __Kona Site Defender__, __App & API Protector with the Advanced Security module__ Return a list of APIs with their constraints and associated actions. - [Modify the request constraint action for all APIs](https://techdocs.akamai.com/application-security/reference/put-api-request-constraints.md): __Kona Site Defender__, __App & API Protector with the Advanced Security module__ Update what action to take when any API request constraint triggers. Use `alert` to record the trigger of the event, `deny` to block the request, or `customDenyId` to apply a custom deny response. - [Modify an API request constraint's action](https://techdocs.akamai.com/application-security/reference/put-api-request-constraints-api.md): __Kona Site Defender__, __App & API Protector with the Advanced Security module__ Update what action to take when the API request constraint triggers. This operation modifies an individual API constraint action. To use this operation, run [List all API request constraints and actions](ref:get-api-request-constraints) and pick an API from the response list. Use `alert` to record the trigger of the event, `deny` to block the request, or `none` to take no action. Currently the only field in the API Request Constraints object is `action`. - [Get evasive path match settings](https://techdocs.akamai.com/application-security/reference/get-evasive-path-match.md): __Web Application Protector__, __Kona Site Defender__ Lists the evasive path match setting for a security policy. Evasive path match is off by default. This setting applies at the security policy level and overrides the setting at the configuration level on a per-policy basis. - [Modify evasive path match settings](https://techdocs.akamai.com/application-security/reference/put-evasive-path-match.md): __Web Application Protector__, __Kona Site Defender__ Enable, disable, or update evasive path match setting for a security policy. This operation applies at the security policy level and overrides the setting at the configuration level on a per-policy basis. - [List malware policy actions](https://techdocs.akamai.com/application-security/reference/get-malware-policies-actions.md): __All products__ Return a list of all malware policies currently in use with the actions each policy takes when conditions are met. - [Modify a malware policy action](https://techdocs.akamai.com/application-security/reference/put-malware-policy-action.md): __All products__ Update the actions in a malware policy. - [Get request body inspection limit settings for a security policy](https://techdocs.akamai.com/application-security/reference/get-policies-request-body.md): __All products__ Return request body inspection limit settings for a security policy. Contact your account team if you'd like to run this operation. - [Modify request body size settings for a security policy](https://techdocs.akamai.com/application-security/reference/put-policies-request-body.md): __All products__ Update inspection settings for a security policy. Inspect request bodies up to a certain size. In exceptional cases, you can change the default value to a set limit: `8`, `16`, or `32` KB. Contact your account team if you'd like to run this operation. - [List API endpoints](https://techdocs.akamai.com/application-security/reference/get-api-endpoints.md): __Kona Site Defender__, __App & API Protector with the Advanced Security module__ List the API endpoints associated with a security policy. This operation only lists the endpoints. To manage them, use [Register an endpoint](https://techdocs.akamai.com/api-gateway/reference/post-endpoints) from the API Endpoint Definition API. - [Get slow POST protection settings](https://techdocs.akamai.com/application-security/reference/get-policy-slow-post.md): __All products__ Get slow POST protection settings for a specific policy. - [Modify slow POST protection settings](https://techdocs.akamai.com/application-security/reference/put-policy-slow-post.md): __All products__ Update slow POST protection settings for a specific policy. - [List rules](https://techdocs.akamai.com/application-security/reference/get-policy-rules.md): __Kona Site Defender__, __App & API Protector with the Advanced Security module__ Returns the action taken for each rule in a policy. The action occurs when the rules are triggered by a request. These are not the same rules as Custom Rules that you configure yourself. These rules are maintained by Akamai. - [Upgrade KRS ruleset](https://techdocs.akamai.com/application-security/reference/put-policy-rules.md): __Kona Site Defender__, __App & API Protector with the Advanced Security module__, __Adaptive Security Engine__ Upgrade to the most recent version of the KRS rule set. Akamai periodically updates these rules to keep protections current. However, the rules you use in your security policies do not automatically upgrade to the latest version when setting `mode` to `KRS`. These rules do update automatically when you have `mode` set to `AAG`. Before you upgrade, run [Get upgrade details](ref:get-rules-upgrade-details) to see which rules have changed. If you want to test how these rules would operate with live traffic before committing to the upgrade, run them in evaluation mode. This applies to KRS rules only and does not allow you to make any changes to the rules themselves. The response is the same as the `mode` response. If you're already using or want to switch from KRS to Adaptive Security Engine (ASE), pass `"upgrade": true,` and `"mode": "ASE_AUTO"` or `ASE_MANUAL` in your request. If you're using Kona Rule Sets, continue to pass only the upgrade value. Note that this operation does not grant access to Adaptive Security Engine. It updates the ASE protections if you already have ASE on your contract. Once you switch to ASE protections, you can't go back to KRS rules. Contact your account team if you want to add ASE to your contract. - [Get upgrade details](https://techdocs.akamai.com/application-security/reference/get-rules-upgrade-details.md): __Kona Site Defender__, __App & API Protector with the Advanced Security module__ Only applies to Kona rule sets. The KRS rule sets are maintained by Akamai's security research team. Run this operation before you upgrade to verify changes in the rule sets. If you want to test how the updates affect your site, you can run the updated rules in evaluation mode. - [Get the action for a rule](https://techdocs.akamai.com/application-security/reference/get-rule.md): __Kona Site Defender__, __App & API Protector with the Advanced Security module__ Return the action a rule takes when triggered. This applies to both ASE auto and ASE manual upgrade modes. Rule actions for `ASE_AUTO` are currently in beta. Contact your account team to access this option. - [Modify the action for a rule](https://techdocs.akamai.com/application-security/reference/put-rule.md): __Kona Site Defender__, __App & API Protector with the Advanced Security module__ Update what action a rule takes when it's triggered. This applies to both ASE auto and ASE manual upgrade modes. Rule actions for `ASE_AUTO` are currently in beta. Contact your account team to access this option. Use `alert` to record the trigger of the event, `deny` to block the request, or `none` to take no action. - [Get the conditions and exceptions of a rule](https://techdocs.akamai.com/application-security/reference/get-rule-condition-exception.md): __Kona Site Defender__, __App & API Protector with the Advanced Security module__ List a KRS rule's conditions and exceptions. - [Modify the conditions and exceptions of a rule](https://techdocs.akamai.com/application-security/reference/put-rule-condition-exception.md): __Kona Site Defender__, __App & API Protector with the Advanced Security module__ Update a rule's conditions and exceptions. When the conditions are met, the rule's actions are ignored and _not_ applied to that specific traffic. - [Get adaptive intelligence settings](https://techdocs.akamai.com/application-security/reference/get-rules-threat-intel.md): __All products__ Returns whether adaptive intelligence is enabled. Adaptive intelligence allows our network to better tune rules for better accuracy. Contact your account team if you'd like to run this operation. - [Modify adaptive intelligence settings](https://techdocs.akamai.com/application-security/reference/put-rules-threat-intel.md): __All products__ Only applies to Adaptive Security Engine (ASE) manual rule sets. Enable or disable adaptive intelligence. Contact your account team if you'd like to run this operation. - [Get a security policy's rule set](https://techdocs.akamai.com/application-security/reference/get-waf-policy-ruleset-composite.md): __All products__ Returns the security policy rule set, which includes the version, threat intelligence settings, rules, and attack group details. - [Modify a security policy's rule set](https://techdocs.akamai.com/application-security/reference/patch-waf-policy-ruleset-composite.md): __All products__ Modify the security policy's rule set including its rule and attack group details. - [Get protections](https://techdocs.akamai.com/application-security/reference/get-policy-protections.md): __All products__ Get the protections and whether they are enabled or disabled in a security policy. - [Modify protections](https://techdocs.akamai.com/application-security/reference/put-policy-protections.md): __All products__ Update the security policy protections. This applies a set of protections that you can enable individually. - [Get the penalty box](https://techdocs.akamai.com/application-security/reference/get-policy-penalty-box.md): __All products__ Returns the penalty box settings for the security policy you specify. - [Modify the penalty box](https://techdocs.akamai.com/application-security/reference/put-policy-penalty-box.md): __All products__ Modifies the penalty box settings for a security policy. When the penalty box is enabled for a policy, clients that trigger a WAF Deny action are placed in the _penalty box_. There, the action you select for penalty box (either `Alert` or `Deny`) continues to apply to any requests from that client for the next 10 minutes. - [Get penalty box condition](https://techdocs.akamai.com/application-security/reference/get-policy-penalty-box-conditions.md): __All products__ Returns the penalty box condition settings for a security policy. - [Modify the penalty box conditions](https://techdocs.akamai.com/application-security/reference/put-policy-penalty-box-conditions.md): __All products__ Modifies the penalty box conditions settings for a security policy. - [Respond to exception recommendations](https://techdocs.akamai.com/application-security/reference/post-recommendations.md): __Adaptive Security Engine__ Accept, decline, or reset the recommended exception. Accepting a tuning recommendation creates or updates the exception for the attack group. Use `reset` to restore a declined recommendation to a neutral state so you can accept it or decline it again later. - [Get tuning recommendations for a policy](https://techdocs.akamai.com/application-security/reference/get-recommendations.md): __Adaptive Security Engine__ Lists available tuning recommendations for a policy. Our system can identify patterns of false positives, and suggests exceptions for you to include in your policy. - [List tuning recommendations for an attack group](https://techdocs.akamai.com/application-security/reference/get-attack-group.md): __Adaptive Security Engine__ Returns available tuning recommendations for an attack group. Our system can identify patterns of false positives, and suggests exceptions for you to include in your attack group. - [List tuning recommendations for a rule](https://techdocs.akamai.com/application-security/reference/get-recommendations-rule.md): __Adaptive Security Engine__ Returns available tuning recommendations for a rule. Our system can identify patterns of false positives, and suggests exceptions for you to include in your rule. In cases where your rules are already optimum, the response payload returns empty. - [List attack groups for a security policy](https://techdocs.akamai.com/application-security/reference/get-policy-attack-groups.md): __All products__ Return a list of attack groups with their associated actions. - [Get the action for an attack group](https://techdocs.akamai.com/application-security/reference/get-policy-attack-group.md): __All products__ Currently the only field in the response object is `action`, which displays the action for the attack group. - [Modify the action for an attack group](https://techdocs.akamai.com/application-security/reference/put-attack-group.md): __All products__ Update what action to take when an attack group's rule triggers. Use `alert` to record the trigger of the event, `deny` to block the request, or `none` to take no action. Currently the only field in the attack group object is `action`. - [Get the exceptions of an attack group](https://techdocs.akamai.com/application-security/reference/get-attack-group-condition-exception.md): __All products__ List an attack group's exceptions. - [Modify the exceptions of an attack group](https://techdocs.akamai.com/application-security/reference/put-attack-group-condition-exception.md): __All products__ Update an attack group exceptions. - [Get the current mode](https://techdocs.akamai.com/application-security/reference/get-policy-mode.md): __All products__ When using Web Application Firewall in your security policy, this mode conveys how you're planning to keep the rules up to date, either `KRS` for manual updates or `AAG` for automatic updates. This operation returns which mode your rules are currently set to. - [Modify the mode](https://techdocs.akamai.com/application-security/reference/put-policy-mode.md): __Kona Site Defender__, __App & API Protector with the Advanced Security module__, __Adaptive Security Engine__ The mode you set determines how your rule sets are updated. Use `KRS` mode to update the rule sets manually, or `AAG` to have them update automatically. If you're using Adaptive Security Engine, use `ASE_AUTO` to update the rules automatically, or `ASE_MANUAL` to update them yourself. - [List rapid rules](https://techdocs.akamai.com/application-security/reference/get-policy-rapid-rules.md): __All products__ Returns rapid rules. [Rapid rules](https://techdocs.akamai.com/app-api-protector/docs/rapid-rules) are WAF rules we are actively testing and refining. You can start using them while we revise them. Once we complete fine-tuning a rule, it becomes a WAF rule you can access through [List rules](doc:get-policy-rules). - [Get rapid rules' default action](https://techdocs.akamai.com/application-security/reference/get-policy-rapid-rules-action.md): __All products__ Returns the default action set for all rapid rules. To override this setting for an individual rule, run [Update a rapid rule's action](doc:put-policy-rapid-rule-action). - [Update rapid rules' default action](https://techdocs.akamai.com/application-security/reference/put-policy-rapid-rules-action.md): __All products__ Set rapid rules default action. This applies to _all_ rapid rules by default unless you specifically override this setting for an individual rule with [Update a rapid rule's action](doc:put-policy-rapid-rule-action). - [Get rapid rules' status](https://techdocs.akamai.com/application-security/reference/get-policy-rapid-rules-status.md): __All products__ Returns whether rapid rules are enabled or disabled. - [Update rapid rules' status](https://techdocs.akamai.com/application-security/reference/put-policy-rapid-rules-status.md): __All products__ Enable or disable all rapid rules. - [List a rapid rule's conditions and exceptions](https://techdocs.akamai.com/application-security/reference/get-policy-rapid-rule-condition-exception.md): __All products__ Returns the conditions and exceptions set for the rapid rule. - [Update a rapid rule's conditions and exceptions](https://techdocs.akamai.com/application-security/reference/put-policy-rapid-rule-condition-exception.md): __All products__ Set the rapid rule's conditions and exceptions. - [Get a rapid rule's lock status](https://techdocs.akamai.com/application-security/reference/get-policy-rapid-rule-lock.md): __All products__ Returns the rapid rule lock status. When locked, the action set for the rapid rule applies to all new versions of that rule. - [Update a rapid rule's lock status](https://techdocs.akamai.com/application-security/reference/put-policy-rapid-rule-lock.md): __All products__ Set the rapid rule lock status. When enabled, the action set for the rapid rule applies to all new versions of that rule. - [Get a rapid rule's action](https://techdocs.akamai.com/application-security/reference/get-policy-rapid-rule-action.md): __All products__ Returns the action for a single rapid rule. Run [Update a rapid rule's action](doc:put-policy-rapid-rule-action) if you want to set different actions for each rule, or override the default action for a single rule. - [Update a rapid rule's action](https://techdocs.akamai.com/application-security/reference/put-policy-rapid-rule-action.md): __All products__ Set the rapid rule's action. Run this operation if you want to set different actions for each rule, or override the default action for a single rule. - [Get WAF Penalty Box settings](https://techdocs.akamai.com/application-security/reference/get-ase-penalty-box-settings.md): __Web Application Protector__, __Kona Site Defender__ Return WAF Penalty Box settings for a specific configuration. - [Modify WAF Penalty Box settings](https://techdocs.akamai.com/application-security/reference/put-ase-penalty-box-settings.md): __Web Application Protector__, __Kona Site Defender__ Update WAF Penalty Box settings for a specific configuration. - [Create a challenge action](https://techdocs.akamai.com/application-security/reference/post-challenge-action.md): Create a new challenge action. Use this action type to insert a challenge, like a CAPTCHA, into the user workflow. You can also apply your own branding to the action to match your website. See [Challenge actions](https://techdocs.akamai.com/app-api-protector/docs/challenge-actions) for more details. - [List challenge actions](https://techdocs.akamai.com/application-security/reference/get-challenge-actions.md): List all of your challenge actions along with their names, challenge types, and other summary information. - [Get a challenge action](https://techdocs.akamai.com/application-security/reference/get-challenge-action.md): View details about the specified challenge action. - [Update a challenge action](https://techdocs.akamai.com/application-security/reference/put-challenge-action.md): Edit the specified challenge action, such as the name, type of challenge, or branding. - [Delete a challenge action](https://techdocs.akamai.com/application-security/reference/delete-challenge-action.md): Remove the specified challenge action. - [Update Google reCAPTCHA secret key](https://techdocs.akamai.com/application-security/reference/put-google-recaptcha-secret-key.md): Specify a different Google reCAPTCHA secret key for a challenge action. The secret key authorizes communication between your site and the reCAPTCHA server. - [List Behavioral DDoS profile actions](https://techdocs.akamai.com/application-security/reference/get-behavioral-ddos-actions.md): Returns a list of all Behavioral DDoS profiles currently in use, along with the actions each profile takes when conditions are met. _Products:_ All. - [Modify a Behavioral DDoS profile action](https://techdocs.akamai.com/application-security/reference/put-behavioral-ddos-profile-action.md): Updates the actions in a Behavioral DDoS profile. _Products:_ All. - [Get the bypass network lists settings for a security policy](https://techdocs.akamai.com/application-security/reference/get-bypass-network-lists-per-policy.md): __Web Application Protector__, __App & API Protector__ Lists which network lists are used in the bypass network lists settings. If you want to add or remove IP addresses from the network lists, use the [Network Lists API](https://techdocs.akamai.com/network-lists/reference/api). - [Modify the bypass network lists settings for a security policy](https://techdocs.akamai.com/application-security/reference/put-bypass-network-lists-per-policy.md): __Web Application Protector__, __App & API Protector__ Update which network lists to use in the bypass network lists settings. If you want to add or remove IP addresses from the network lists, use the [Network Lists API](https://techdocs.akamai.com/network-lists/reference/api). - [Get Client-Side Protection & Compliance settings](https://techdocs.akamai.com/application-security/reference/get-policy-cpc.md): __All products__ Get Client-Side Protection & Compliance settings for a specific policy. For more information, see [Client-side Protection & Compliance](https://techdocs.akamai.com/client-side-protect-compliance/docs/client-side-protect-compliance-ov) - [Modify Client-Side Protections & Compliance settings](https://techdocs.akamai.com/application-security/reference/put-policy-cpc.md): __All products__ Update Client-Side Protection & Compliance settings for a specific policy. - [List selected hostnames for a security policy](https://techdocs.akamai.com/application-security/reference/get-selected-hostnames-per-policy.md): __Web Application Protector__, __App & API Protector__ List the hostnames that the configuration version selects as candidates of protected hostnames, which you can use in match targets. - [Modify selected hostnames for a security policy](https://techdocs.akamai.com/application-security/reference/put-selected-hostnames-per-config.md): __Web Application Protector__, __App & API Protector__ Update the list of selected hostnames for a configuration. You can add an individual hostname to your selected hostnames list without passing the entire list plus the new hostname in this PUT object. Previously, you needed to pass every hostname in the PUT object or any hostnames not included would be deleted from the list. - [Get the exceptions of an evaluation attack group](https://techdocs.akamai.com/application-security/reference/get-eval-group-condition-exception.md): __All products__ List an attack group's exceptions. - [Modify the exceptions of an evaluation attack group](https://techdocs.akamai.com/application-security/reference/put-eval-group-condition-exception.md): __All products__ Update an evaluation attack group exceptions. - [Get the conditions and exceptions for an evaluation rule](https://techdocs.akamai.com/application-security/reference/get-condition-exception.md): __Kona Site Defender__, __App & API Protector with the Advanced Security module__ List the conditions and exceptions for a rule you want to evaluate. This operation returns the same object type as other condition and exception operations. Keep in mind that the response for this operation applies to the rules you're evaluating even though the concept of conditions and exceptions is the same for all condition exception endpoints. - [Modify the conditions and exceptions for an evaluation rule](https://techdocs.akamai.com/application-security/reference/put-condition-exception.md): __Kona Site Defender__, __App & API Protector with the Advanced Security module__ Update an evaluation rule's conditions and exceptions. When the conditions are met, the rule's actions are ignored and not applied to that specific traffic. The rule action you update with this operation is for a rule you are evaluating and not a rule currently in use for your site or app. - [List evaluation hostnames for a security policy](https://techdocs.akamai.com/application-security/reference/get-eval-hostnames.md): __Web Application Protector__, __App & API Protector__ List the evaluation hostnames for a configuration version. Evaluation mode for hostnames is only available for Web Application Protector. Run hostnames in evaluation mode to see how your configuration settings protect traffic for that hostname before adding a hostname directly to a live configuration. Once you begin, the hostnames you evaluate start responding to traffic as if they are your current hostnames. However, instead of taking an action the evaluation hostnames log which action they would have taken if they were your actively protected hostnames and not a test. - [Modify evaluation hostnames for a security policy](https://techdocs.akamai.com/application-security/reference/put-eval-hostnames.md): __Web Application Protector__, __App & API Protector__ Update the list of hostnames you want to evaluate for a configuration version. - [Protect evaluation hostnames for a security policy](https://techdocs.akamai.com/application-security/reference/put-protect-eval-hostnames-per-policy.md): __Web Application Protector__, __App & API Protector__ Move hostnames you're evaluating to active protection. When you move a hostname from the evaluation hostnames list, it's added to your security policy as a protected hostname. You'll see that hostname in the response object the next time you run [List selected hostnames](ref:get-selected-hostnames). - [Set evaluation mode](https://techdocs.akamai.com/application-security/reference/post-policy-eval.md): __Kona Site Defender__, __App & API Protector with the Advanced Security module__ Evaluation mode runs concurrently with your existing Web Application Firewall Rule settings and records how the rules would respond if they were applied to live traffic. The default action for evaluation rules is `alert`. Unlike other POST or PUT actions, this request object supports values other than `enabled` or `disabled`. Use `START` to begin evaluation mode. An evaluation period lasts four weeks unless you stop the evaluation. Once you begin, the rules you evaluate will respond to traffic as if they are your current rules. However, instead of taking an action the evaluation rules will log which action they would have taken if they were your active rules and not a test of future rules. Use `STOP` to end the evaluation before it completes on its own, and not upgrade your rules. Use `RESTART` to start an evaluation you previously stopped, or one that has expired. Use `COMPLETE` to stop your in-progress evaluation and automatically upgrade your existing KRS rules to the rule set you just evaluated. Use `UPDATE` to upgrade to the newest available version of evaluation rules. A request value of `START`, `RESTART`, or `COMPLETE` returns an `eval` value of `enabled`. A request value of `STOP` or `UPDATE` returns an `eval` value of `disabled`. If you're using Adaptive Security Engine, pass `eval` as usual, and add `"mode": "ASE_AUTO"` or `ASE_MANUAL` in your request. If you're using Kona Rule Sets, continue to pass only the `eval` value. - [Get the penalty box for a policy in evaluation mode](https://techdocs.akamai.com/application-security/reference/get-eval-policy-penalty-box.md): __All products__ Returns the penalty box settings for a security policy in evaluation mode. When the penalty box is enabled for a policy, clients that trigger a Web Application Firewall deny action are placed in the penalty box. There, the action you select for penalty box (either `alert` or `deny`) continues to apply to any requests from that client for the next 10 minutes. - [Modify the evaluation penalty box](https://techdocs.akamai.com/application-security/reference/put-eval-policy-penalty-box.md): __All products__ Update the penalty box settings for a security policy in evaluation mode. If set to `true`, you can choose to `deny` requests coming from a client in the penalty box, or trigger an `alert` instead. - [List evaluation rules](https://techdocs.akamai.com/application-security/reference/get-policy-eval-rules.md): __Kona Site Defender__, __App & API Protector with the Advanced Security module__ Return the rules available for evaluation and their actions. - [Get the action of an evaluation rule](https://techdocs.akamai.com/application-security/reference/get-policy-eval-rule.md): __Kona Site Defender__, __App & API Protector with the Advanced Security module__ Return the action for a specific rule you want to evaluate. This applies to both ASE auto and ASE manual upgrade modes. You may need additional permissions to add or update rule actions in `ASE_AUTO` mode. - [Modify the action of an evaluation rule](https://techdocs.akamai.com/application-security/reference/put-policy-eval-rule.md): __Kona Site Defender__, __App & API Protector with the Advanced Security module__ Update the action for a specific rule you want to evaluate. Like your current rules, actions are `alert` to record the trigger of the event, `deny` to block the request, or `none` to take no action. This applies to both ASE auto and ASE manual upgrade modes. You may need additional permissions to add or update rule actions in `ASE_AUTO` mode. - [List evaluation attack groups](https://techdocs.akamai.com/application-security/reference/get-policy-eval-groups.md): __All products__ Return a list of evaluation attack groups with their associated actions. - [Get the action for an evaluation attack group](https://techdocs.akamai.com/application-security/reference/get-policy-eval-group.md): __All products__ Currently the only field in the response object is `action`, which displays the action for the evaluation attack group. - [Modify the action for an evaluation attack group](https://techdocs.akamai.com/application-security/reference/put-eval-group.md): __All products__ Update what action to take when an evaluation attack group's rule triggers. Use `alert` to record the trigger of the event, `deny` to block the request, or `none` to take no action. Currently the only field in the attack group object is `action`. - [Get penalty box conditions in evaluation mode](https://techdocs.akamai.com/application-security/reference/get-eval-policy-penalty-box-conditions.md): __All products__ Returns the penalty box condition settings for a security policy in evaluation mode. - [Modify the penalty box conditions in evaluation mode](https://techdocs.akamai.com/application-security/reference/put-eval-policy-penalty-box-conditions.md): __All products__ Modifies the penalty box condition settings for a security policy in evaluation mode. - [Protect evaluation hostnames](https://techdocs.akamai.com/application-security/reference/put-protect-eval-hostnames.md): __Web Application Protector__, __App & API Protector__ Move hostnames you're evaluating to active protection. When you move a hostname from the evaluation hostnames list, it's added to your security policy as a protected hostname. You'll see that hostname in the response object the next time you run [List selected hostnames](ref:get-selected-hostnames). - [List evaluation hostnames](https://techdocs.akamai.com/application-security/reference/get-selected-hostnames-eval-hostnames.md): __Web Application Protector__, __App & API Protector__ List the evaluation hostnames for a configuration version. Evaluation mode for hostnames is only available for Web Application Protector and App & API Protector. Run hostnames in evaluation mode to see how your configuration settings protect traffic for that hostname before adding a hostname directly to a live configuration. Once you begin, the hostnames you evaluate start responding to traffic as if they are your current hostnames. However, instead of taking an action the evaluation hostnames log which action they would have taken if they were your actively protected hostnames and not a test. - [Modify evaluation hostnames](https://techdocs.akamai.com/application-security/reference/put-selected-eval-hostnames.md): __Web Application Protector__, __App & API Protector__ Update the list of hostnames you want to evaluate for a configuration version. - [List discovered APIs](https://techdocs.akamai.com/application-security/reference/get-api-list.md): __All products__ List APIs discovered in your traffic that are new or not yet protected under API protections. An API is considered new if it isn't registered, and appears in the discovered APIs list if it's had at least 1000 requests over the last 30 days and at least one 2xx response. - [Get a discovered API](https://techdocs.akamai.com/application-security/reference/get-api-details.md): __All products__ Returns details about an API discovered in account traffic. It is identified based on hostname and basepath. - [Subscribe or unsubscribe to recommendation emails](https://techdocs.akamai.com/application-security/reference/post-subscription-feature.md): __Kona Site Defender__ Set the request object's `action` to `subscribe` to add user emails to the subscription object. Use `unsubscribe` to remove them from the list. The lists are organized by `features`. Currently available `feature` values are `AAG_TUNING_REC` for AAG and ASE rule sets, and `WAF_RULE_UPDATE` for ASE rule sets. - [List subscribers](https://techdocs.akamai.com/application-security/reference/get-subscription-feature.md): __Kona Site Defender__ List all subscribers to a security configuration's `feature`. The response array is empty if there are no subscribers. Currently available `feature` values are `AAG_TUNING_REC` for AAG and ASE rule sets, and `WAF_RULE_UPDATE` for ASE rule sets. - [Modify an API's visibility](https://techdocs.akamai.com/application-security/reference/put-api-visibility.md): __All products__ Hide or show an API. You can choose to include or exclude APIs from the [Get discovered APIs](ref:get-api-list) response. This operation is per-user. If you hide an API from the response, another of your colleagues will still see that API in the response when they run this operation with their own credentials. - [Create an endpoint or resource](https://techdocs.akamai.com/application-security/reference/post-api-endpoint-resource.md): __All products__ Create a new API endpoint or add a resource to an existing endpoint. When you run this operation to add a new resource to an existing API, the API version is cloned for you and the resource is included in the new version. - [List discovered API endpoints](https://techdocs.akamai.com/application-security/reference/get-discovered-api-endpoints.md): __All products__ Returns API endpoints for the specified hostname and base path. Unlike [Get discovered APIs](ref:get-api-list), this operation returns APIs already in your API definitions. When you see a discovered API or a new resource, add it to your definition with [Create an endpoint or resource](ref:post-api-endpoint-resource). - [List contracts and groups](https://techdocs.akamai.com/application-security/reference/get-contracts-groups.md): __All products__ List the contracts and groups for your account. Each object contains the contract, groups associated with the contract, and whether Kona Site Defender or Web Application Protector is the product for that contract. You'll need this information when you create a new security configuration or when you want to get a list of hostnames still available for use in a security policy. - [List available hostnames for a new configuration](https://techdocs.akamai.com/application-security/reference/get-selectable-hostnames-per-config.md): __All products__ Lists the hostnames for a given contract and group. Use this operation for a new configuration, and use [List selectable hostnames](ref:get-selectable-hostnames) to see a list of hostnames you can add to an existing configuration. This operation shows you every acceptable hostname you can use, where the other hostname operation omits any hostnames already included in your configuration. - [Get hostname coverage](https://techdocs.akamai.com/application-security/reference/get-hostname-coverage.md): __Kona Site Defender__, __App & API Protector with the Advanced Security module__ Get the list of hostnames in the account with their current protections, activation statuses, and other summary information. - [List CVEs](https://techdocs.akamai.com/application-security/reference/get-cves.md): List CVEs currently in Akamai's CVE catalog. The catalog contains only CVEs the Akamai Threat Research team is aware of. App & API Protector can identify and block attacks related to the active exploitation of many more CVEs and attacks without associated known vulnerabilities. - [Subscribe to CVEs](https://techdocs.akamai.com/application-security/reference/post-subscribe.md): Subscribe to notifications for specific CVEs. - [List subscribed CVEs](https://techdocs.akamai.com/application-security/reference/get-subscribed.md): List the CVEs you are subscribed to. To add or remove CVEs, run [Subscribe to CVEs](doc:post-subscribe) or [Unsubscribe from CVEs](doc:post-unsubscribe) accordingly. - [Unsubscribe from CVEs](https://techdocs.akamai.com/application-security/reference/post-unsubscribe.md): Unsubscribe from notifications about all CVEs, or specific CVEs. - [Get a CVE](https://techdocs.akamai.com/application-security/reference/get-cve.md): Get details for a specific CVE. - [Get CVE coverage](https://techdocs.akamai.com/application-security/reference/get-security-coverage.md): The coverages provided by your configurations, attack groups, and rules. - [List managed rules](https://techdocs.akamai.com/application-security/reference/get-rules.md): List all managed rules across rule types (`ase`, `rapid`, `ai`) currently available in Akamai's catalog. Use this endpoint to discover rule metadata independent of any specific security configuration. - [List attack groups](https://techdocs.akamai.com/application-security/reference/get-attack-groups.md): List all attack groups currently available in Akamai's catalog. Use this endpoint to discover attack group metadata independent of any specific security configuration. - [Activate a configuration version](https://techdocs.akamai.com/application-security/reference/post-activations.md): __All products__ Activates one or more configurations globally. Note that you need to explicitly list any invalid hosts in the `acknowledgedInvalidHostsByConfig` parameter in order to successfully activate a configuration that includes invalid hostnames. If you have an invalid hostname that isn't explicitly called out you'll receive an error telling you to add them to `acknowledgedInvalidHostsByConfig`. See [Activate with invalid hostnames](ref:activate-with-invalid-hostnames) for instructions. - [Export a configuration version](https://techdocs.akamai.com/application-security/reference/get-export-config-version.md): __All products__ Returns comprehensive details about a security configuration version. This operation returns more data than [Get configuration version details](https://techdocs.akamai.com/application-security/reference/get-version-number), including Bot Manager protections, rate and security policies, rules, hostnames, and numerous additional settings. - [Asynchronously export a configuration version](https://techdocs.akamai.com/application-security/reference/post-export-config-version-async-task.md): __All products__ Start an asynchronous export of a security configuration version. The response contains an `exportId` you can use to monitor progress and get the export data once it's ready. - [Get asynchronous export results](https://techdocs.akamai.com/application-security/reference/get-export-config-version-async-result.md): __All products__ Get a security configuration version's export data from a previously completed asynchronous task. This is only available when the task status is `COMPLETED`. - [Get asynchronous export status](https://techdocs.akamai.com/application-security/reference/get-export-config-version-async-task-status.md): __All products__ Get a security configuration version's export status. When `PENDING`, the task is still running. When `COMPLETED`, the task finished successfully and you can collect the results through the link in the response. A status of `FAILED` appears when the task can't complete. - [List activation history](https://techdocs.akamai.com/application-security/reference/get-activation-history.md): __All products__ Lists the activation history for a configuration. The history is an array in descending order of `submitDate`. The most recent submitted activation lists first. - [Get an activation request status](https://techdocs.akamai.com/application-security/reference/get-activations-status.md): __All products__ Returns the status of a long-running activation request. Any errors that occur when generating the activation cause this API to respond with the underlying error status. - [Get activation status](https://techdocs.akamai.com/application-security/reference/get-activation.md): __All products__ Returns the status of an activation. - [Compare two versions](https://techdocs.akamai.com/application-security/reference/post-config-versions-diff.md): __All products__ This operation shows you differences between configuration versions. The `to` version is relative to the `from` version, and the versions you compare can be non-sequential. This means the `from` value can be more a more recent version than the `to` value. For more information, see [Diff configuration versions](ref:diff-configuration-versions). - [Create an onboarding](https://techdocs.akamai.com/application-security/reference/post-onboarding.md): __App & API Protector__, __App & API Protector with the Advanced Security module__ Create a new onboarding. To start, you'll need a valid set of hostnames that either need delivery settings, an Akamai-owned certificate from the Certificate Provisioning System (CPS), and security protections, or have delivery settings complete and only need security protections. However, you can include only one type of these hostnames per onboarding, not both. If you have both kinds of hostnames, those that need delivery settings, a CPS certificate, and security protections, and those that only need security protections, you'll need to create two onboarding objects. The response object is your newly created onboarding. - [List onboardings](https://techdocs.akamai.com/application-security/reference/get-onboardings.md): __App & API Protector__, __App & API Protector with the Advanced Security module__ Lists onboardings. You can filter results by hostname or onboarding status. - [Get an onboarding](https://techdocs.akamai.com/application-security/reference/get-onboarding.md): __App & API Protector__, __App & API Protector with the Advanced Security module__ Get an onboarding's details. Once you've completed all steps in the onboarding process, run this call again to verify `onboardingStatus: "COMPLETE"`. - [Delete an onboarding](https://techdocs.akamai.com/application-security/reference/delete-onboarding.md): __App & API Protector__, __App & API Protector with the Advanced Security module__ Delete a specific onboarding. You can't delete an onboarding that has an activation in progress. To delete an onboarding that's activating, wait for the activation to complete, then run this operation. - [Get onboarding settings](https://techdocs.akamai.com/application-security/reference/get-onboarding-settings.md): __App & API Protector__, __App & API Protector with the Advanced Security module__ Gets the settings for a specific onboarding. - [Modify onboarding settings](https://techdocs.akamai.com/application-security/reference/put-onboarding-settings.md): __App & API Protector__, __App & API Protector with the Advanced Security module__ Update the settings in an onboarding. You can't update settings for an onboarding object that has already activated on staging or production. You can, however, change settings for an onboarding that has not been activated. - [List onboarding certificate challenges](https://techdocs.akamai.com/application-security/reference/get-onboarding-certificate-validation.md): __All products__ Returns the information you need to validate your certificate. Add the `TXT` DNS record listed in the response to your DNS record. Adding the `TXT` record won't affect your website. Once you've added the `TXT` record, and before the token expires, run [Validate onboarding certificate](doc:post-onboarding-certificate-validation) to validate the certificate. - [Validate onboarding certificate](https://techdocs.akamai.com/application-security/reference/post-onboarding-certificate-validation.md): __All products__ Validates the certificate's `TXT` DNS record. Once validation completes, it takes about five minutes to deploy the certificates across Akamai's global network. You can validate with HTTP token, DNS records, or URL redirect. - [List hostname CNAME DNS records](https://techdocs.akamai.com/application-security/reference/get-onboarding-cname-records.md): __All products__ Returns the DNS records you need to CNAME to Akamai. Once you update your CNAME record with the information in this call's response, your end user traffic starts to flow through Akamai's platform. Note that you can only CNAME to Akamai after an activation on staging or production is complete. - [Validate hostname CNAME DNS records](https://techdocs.akamai.com/application-security/reference/post-validate-onboarding-cname-records.md): __All products__ Validates your site is ready to serve traffic. Call this operation after you've replaced the DNS entry that directs traffic to your site with the DNS CNAME records in [List hostname CNAME DNS records](doc:get-onboarding-cname-records). In each record, set the time-to-live (TTL) to 300 seconds (5 minutes). Once this call completes, run [Get an onboarding](doc:get-onboarding) to verify your onboarding is complete. When you've successfully completed any validations and CNAME changes, you'll see `onboardingStatus: "COMPLETE"` in the response. - [List origin hostname DNS records](https://techdocs.akamai.com/application-security/reference/get-onboarding-origin-validation.md): __All products__ Lists the DNS records for your origin. Once you make this call, visit your DNS provider account and create a new DNS type `A` record with the values returned in the response. In the rare case that you changed your origin values outside this setup, you can run [Skip origin validation](doc:post-skip-onboarding-origin-validation) to proceed to the next step without validating your origin at this time. - [List onboarding domain challenges](https://techdocs.akamai.com/application-security/reference/get-onboarding-domain-validation.md): __All products__ Returns the information you need to validate your domains. Add the `TXT` or `CNAME` value listed in the response to your DNS record. Adding the record won't affect your website. Once you've added the record, and before the token expires, run [Validate onboarding domains](doc:post-onboarding-domain-validation). - [Skip origin hostnames DNS record validation](https://techdocs.akamai.com/application-security/reference/post-skip-onboarding-origin-validation.md): __All products__ Skips the validation of `A` DNS record. In the rare case that you changed your origin values outside this onboarding, you can choose not to complete the origin validation process through this onboarding workflow. Skipping for any other reason may cause your site to become unreachable. When you choose to skip validating your origin through this call, the response shows the records with a value of `skipped`. - [Validate onboarding domains](https://techdocs.akamai.com/application-security/reference/post-onboarding-domain-validation.md): __All products__ Verifies the domain validation challenges. Note that to activate your onboarding, you need to validate your hostnames using this operation. You can validate with HTTP token, DNS records, or URL redirect. When validation completes you can [Activate an onboarding](post-onboarding-activation). - [Validate origin hostnames DNS records](https://techdocs.akamai.com/application-security/reference/post-onboarding-origin-validation.md): __All products__ Validates the `A` DNS record you entered into your DNS record. In the rare case that you changed your origin values outside this setup, you can run [Skip origin validation](doc:post-skip-onboarding-origin-validation) to proceed to the next step without validating your origin at this time. - [Activate an onboarding](https://techdocs.akamai.com/application-security/reference/post-onboarding-activation.md): __App & API Protector__, __App & API Protector with the Advanced Security module__ Activate an onboarding on the staging or production networks. Before you can proceed, call [Validate onboarding domains](doc:post-onboarding-domain-validation) to confirm domain ownership. You'll need to validate using the Application Security API even if you've previously validated elsewhere. Note that you need to activate on the staging network before you can activate on production. Additionally, with this operation you can only activate on one network at a time. Once you activate on staging, you can test your site as you normally would when using Property Manager or any of our security products. - [Get an onboarding activation](https://techdocs.akamai.com/application-security/reference/get-onboarding-activation-status.md): __App & API Protector__, __App & API Protector with the Advanced Security module__ Returns the status of an activation. Activations can take about 20 minutes. If the activation fails, to specific information about the failure is returned in the error response. ## Changelog - [Feb. 10, 2025 — Handle emerging threats with rapid rules API and terraform](https://techdocs.akamai.com/application-security/changelog/feb-10-2025-handle-emerging-threats-with-rapid-rules-api-and-terraform.md) - [June 29, 2023 — Application Security API documentation enhancements](https://techdocs.akamai.com/application-security/changelog/june-28-2023-application-security-api-documentation-enhancements.md) - [May 15, 2023 — Application Security API documentation enhancements](https://techdocs.akamai.com/application-security/changelog/may-15-2023-application-security-api-documentation-enhancements.md) - [Upcoming change window: May 15, 2023](https://techdocs.akamai.com/application-security/changelog/upcoming-change-window-may-15-2023.md) - [Mar 8, 2023 — Application Security API updates](https://techdocs.akamai.com/application-security/changelog/feb-28-2023-application-security-api-updates.md) # Aura Documentation > Aura Licensed CDN (LCDN) is a highly-scalable, multi-purpose CDN for network operators. With Aura LCDN you can deliver high-quality, low-latency viewing experiences for both live and on-demand video content. The Aura Licensed Multicast Solution (LMS) is an extension of the Aura LCDN that uses IP Multicast technology to deliver the same Adaptive Bitrate (ABR) video content to multiple viewers simultaneously, similar to traditional broadcast methodology. ## Guides - [Welcome to Aura Licensed Products](https://techdocs.akamai.com/aura/docs/welcome-to-aura.md) # Build on the cloud Documentation > Follow this tutorial to set up highly available compute instances to deliver a basic site. ## Guides - [Get started](https://techdocs.akamai.com/get-started-cloud-computing/docs/get-started.md) - [1. Get access](https://techdocs.akamai.com/get-started-cloud-computing/docs/get-access-ui.md) - [2. Set up Linodes](https://techdocs.akamai.com/get-started-cloud-computing/docs/set-up-linodes-ui.md) - [Apache2 quick config](https://techdocs.akamai.com/get-started-cloud-computing/docs/apache-quick-config.md) - [3. Get your edge certificate](https://techdocs.akamai.com/get-started-cloud-computing/docs/get-your-certificate-ui.md) - [4. Define your property](https://techdocs.akamai.com/get-started-cloud-computing/docs/define-your-property-ui.md) - [5. Test and go live](https://techdocs.akamai.com/get-started-cloud-computing/docs/test-and-go-live-ui.md) - [1. Get access](https://techdocs.akamai.com/get-started-cloud-computing/docs/get-access-api.md) - [2. Set up Linodes](https://techdocs.akamai.com/get-started-cloud-computing/docs/set-up-linodes-api.md) - [Install and configure a LAMP stack](https://techdocs.akamai.com/get-started-cloud-computing/docs/install-lamp-api.md) - [3. Get your edge certificate](https://techdocs.akamai.com/get-started-cloud-computing/docs/get-your-edge-certificate-api.md) - [4. Define your property](https://techdocs.akamai.com/get-started-cloud-computing/docs/define-your-property-api.md) - [Manage with a code editor](https://techdocs.akamai.com/get-started-cloud-computing/docs/manage-with-a-code-editor.md) - [5. Test and go live](https://techdocs.akamai.com/get-started-cloud-computing/docs/test-and-go-live-api.md) - [Add features](https://techdocs.akamai.com/get-started-cloud-computing/docs/add-features.md) - [Run reports](https://techdocs.akamai.com/get-started-cloud-computing/docs/run-reports.md) # Certificate Provisioning System Documentation > Akamai’s Certificate Provisioning System (CPS) allows you to self-provision and manage your Secure Sockets Layer (SSL) and Transport Layer Security (TLS) certificates. It supports all certificate options, including third party. ## Guides - [Welcome to Certificate Provisioning System](https://techdocs.akamai.com/cps/docs/welcome-cert-prov-system.md) - [Prerequisites and requirements](https://techdocs.akamai.com/cps/docs/prerequisites-req.md) - [Key concepts and terms](https://techdocs.akamai.com/cps/docs/key-concepts-terms.md) - [CPS workflow](https://techdocs.akamai.com/cps/docs/cps-workflow.md) - [Get started with CPS](https://techdocs.akamai.com/cps/docs/get-started-cps.md) - [Create a third-party certificate](https://techdocs.akamai.com/cps/docs/create-a-third-party-certificate.md) - [Create an extended-validated certificate](https://techdocs.akamai.com/cps/docs/create-an-extended-validated-certificate.md) - [Create an organization-validated certificate](https://techdocs.akamai.com/cps/docs/create-an-organization-validated-certificate.md) - [Create a domain-validated certificate](https://techdocs.akamai.com/cps/docs/create-a-domain-validated-certificate.md) - [View existing certificates](https://techdocs.akamai.com/cps/docs/view-existing-certs.md) - [View validation status](https://techdocs.akamai.com/cps/docs/view-val-status.md) - [View validation instructions](https://techdocs.akamai.com/cps/docs/view-val-instructions.md) - [View certificate activity and history](https://techdocs.akamai.com/cps/docs/view-cert-activity-history.md) - [View certificates](https://techdocs.akamai.com/cps/docs/view-certificates.md) - [View active certificates](https://techdocs.akamai.com/cps/docs/view-active-certs.md) - [View in-progress certificates](https://techdocs.akamai.com/cps/docs/view-progress-certs.md) - [View drafts](https://techdocs.akamai.com/cps/docs/view-drafts.md) - [Search certificates](https://techdocs.akamai.com/cps/docs/find-certs.md) - [Manage certificate deployment](https://techdocs.akamai.com/cps/docs/manage-cert-deploy.md) - [Deploy to staging before production for testing](https://techdocs.akamai.com/cps/docs/deploy-stage-before-prod-testing.md) - [Edit deployment settings](https://techdocs.akamai.com/cps/docs/view-edit-network-deploy-settings.md) - [Force a certificate's early renewal](https://techdocs.akamai.com/cps/docs/force-early-renewal.md) - [Push a certificate from staging to production](https://techdocs.akamai.com/cps/docs/push-cert-stage-prod.md) - [Test your certificate on the staging network](https://techdocs.akamai.com/cps/docs/test-cert-stage-network.md) - [Update SSL/TLS cipher profiles](https://techdocs.akamai.com/cps/docs/cipher-profiles.md) - [Manage certificates](https://techdocs.akamai.com/cps/docs/manage-certs.md) - [Add a CNAME to a DNS record](https://techdocs.akamai.com/cps/docs/add-cname-dns-record.md) - [Add a missing certificate](https://techdocs.akamai.com/cps/docs/add-missing-cert.md) - [Cancel a pending change](https://techdocs.akamai.com/cps/docs/cancel-pending-change.md) - [Delete a certificate](https://techdocs.akamai.com/cps/docs/delete-certs.md) - [Download or copy the CSRs for third-party certificates](https://techdocs.akamai.com/cps/docs/dl-copy-csrs-3p-certs.md) - [Edit a certificate](https://techdocs.akamai.com/cps/docs/create-edit-certs.md) - [Enter certificate information](https://techdocs.akamai.com/cps/docs/enter-cert-info.md) - [Enter company information](https://techdocs.akamai.com/cps/docs/enter-company-info.md) - [Enter contact information](https://techdocs.akamai.com/cps/docs/enter-contact-info.md) - [Renew a DV certificate](https://techdocs.akamai.com/cps/docs/renew-dv-cert.md) - [Remove failed domains](https://techdocs.akamai.com/cps/docs/rm-fail-domains.md) - [Select a validation type](https://techdocs.akamai.com/cps/docs/select-val-type.md) - [Select a trust chain](https://techdocs.akamai.com/cps/docs/select-trust-chain.md) - [Select certificate settings](https://techdocs.akamai.com/cps/docs/select-cert-settings.md) - [Select network settings](https://techdocs.akamai.com/cps/docs/select-network-settings.md) - [Save a draft](https://techdocs.akamai.com/cps/docs/save-draft.md) - [Upload a third-party certificate and trust chain](https://techdocs.akamai.com/cps/docs/upload-3p-cert-trust-chain.md) - [Validate domains](https://techdocs.akamai.com/cps/docs/val-domains.md) ## API Reference - [Certificate Provisioning System API v2](https://techdocs.akamai.com/cps/reference/api.md) - [API summary](https://techdocs.akamai.com/cps/reference/api-summary.md) - [Get started](https://techdocs.akamai.com/cps/reference/get-started.md) - [API concepts](https://techdocs.akamai.com/cps/reference/api-concepts.md) - [X509 certificates](https://techdocs.akamai.com/cps/reference/x509-certificates.md) - [Certificate authorities](https://techdocs.akamai.com/cps/reference/certificate-authorities.md) - [Validation](https://techdocs.akamai.com/cps/reference/validation.md) - [Enrollments](https://techdocs.akamai.com/cps/reference/enrollments-ref.md) - [Resources related to enrollments](https://techdocs.akamai.com/cps/reference/resources-related-to-enrollments.md) - [Certificate pinning](https://techdocs.akamai.com/cps/reference/certificate-pinning.md) - [API workflow](https://techdocs.akamai.com/cps/reference/about-the-cps-workflow.md) - [Create a domain-validated certificate](https://techdocs.akamai.com/cps/reference/create-a-domain-validated-cert.md) - [Change control](https://techdocs.akamai.com/cps/reference/change-input-content-type-mapping.md) - [Change management](https://techdocs.akamai.com/cps/reference/change-mgmt.md) - [Pre and Post-verification warnings](https://techdocs.akamai.com/cps/reference/pre-post-verification-warnings.md) - [Let's Encrypt challenges](https://techdocs.akamai.com/cps/reference/lets-encrypt-challenges.md) - [Third-party](https://techdocs.akamai.com/cps/reference/third-party.md) - [Object versioning](https://techdocs.akamai.com/cps/reference/internal-versioning.md) - [Acknowledgement object](https://techdocs.akamai.com/cps/reference/acknowledgement.md) - [Certificate object](https://techdocs.akamai.com/cps/reference/certificate.md) - [CertificateHistory object](https://techdocs.akamai.com/cps/reference/certificate-history.md) - [Change object](https://techdocs.akamai.com/cps/reference/change.md) - [ChangeHistory object](https://techdocs.akamai.com/cps/reference/change-history.md) - [ChangeManagement object](https://techdocs.akamai.com/cps/reference/change-management.md) - [CSR object](https://techdocs.akamai.com/cps/reference/csr.md) - [Deployment object](https://techdocs.akamai.com/cps/reference/deployment.md) - [DeploymentSchedule object](https://techdocs.akamai.com/cps/reference/deployment-schedule.md) - [DvChallenges object](https://techdocs.akamai.com/cps/reference/dvchallenges.md) - [DvHistory object](https://techdocs.akamai.com/cps/reference/dv-history.md) - [Enrollment object](https://techdocs.akamai.com/cps/reference/enrollment-object.md) - [Organization object](https://techdocs.akamai.com/cps/reference/organization.md) - [TrustChains object](https://techdocs.akamai.com/cps/reference/trust-chains.md) - [Rate limiting](https://techdocs.akamai.com/cps/reference/rate-limiting.md) - [Status values](https://techdocs.akamai.com/cps/reference/status-values-and-descriptions.md) - [Errors](https://techdocs.akamai.com/cps/reference/api-errors.md) - [400](https://techdocs.akamai.com/cps/reference/400.md) - [409](https://techdocs.akamai.com/cps/reference/409.md) - [429](https://techdocs.akamai.com/cps/reference/429.md) - [500](https://techdocs.akamai.com/cps/reference/500.md) - [Create an enrollment](https://techdocs.akamai.com/cps/reference/post-enrollment.md): Creates an enrollment that contains all the information about the process that your certificate goes through from the time you request it, through renewal, and as you obtain subsequent versions. To select a Client TLS Renegotiation option, use the CPS user interface. For details, see [Edit deployment settings](doc:view-edit-network-deploy-settings). Note that you can create one certificate every five minutes, per account. Creating a certificate for the same contract within the five-minute interval results in a 409 response. - [List enrollments](https://techdocs.akamai.com/cps/reference/get-enrollments.md): A list of the names of each enrollment. - [Get an enrollment](https://techdocs.akamai.com/cps/reference/get-enrollment.md): Gets an enrollment. - [Update an enrollment](https://techdocs.akamai.com/cps/reference/put-enrollment.md): Updates an enrollment with changes. Response type varies depending on the type and impact of change. For example, changing SANs list may return HTTP 202 Accepted since the operation requires a new certificate and network deployment operations, and thus can't be completed without a change. On the contrary, for example a Technical Contact name change may return HTTP 200 OK assuming there are no active change and when the operation does not require a new certificate. Note that `fipsMode` requires that TLS 1.2, TLS 1.3, or both are enabled on the certificate. You can’t list these TLS versions as disabled in the `disallowedTlsVersions` deployment object. When `fipsMode` is enabled, you need to use an active (non-deprecated) cipher profile for both `mustHaveCiphers` and `preferredCiphers`. For details, see [Update SSL/TLS cipher profiles](doc:cipher-profiles). - [Remove an enrollment](https://techdocs.akamai.com/cps/reference/delete-enrollment.md): Removes an enrollment from CPS. The response code varies depending on the state of the enrollment. Deleting an enrollment in the future, or deleting when the enrollment has a certificate deployed to the network, may result in a 202 response. Deleting an enrollment that hasn't yet deployed any certificate to the network responds immediately with a 200 code. - [Get DV history](https://techdocs.akamai.com/cps/reference/get-dv-history.md): Domain name Validation history for the enrollment. - [Get certificate history](https://techdocs.akamai.com/cps/reference/get-history-certificates.md): View the certificate history. To view deployed certificates and their expiration dates, run the [Get production deployment](ref:get-deployments-production) operation. Note that for enrollments with six certificates or fewer, the response yields up to twelve years of data per certificate. If there are more than six certificates in the enrollment, the response shows a truncated set. To view all changes or certificates, use the `includeAll=true` query parameter in the request. - [Update a deployment schedule](https://techdocs.akamai.com/cps/reference/put-change-deployment-schedule.md): Updates the current deployment schedule. - [List deployments](https://techdocs.akamai.com/cps/reference/get-deployments.md): Lists the deployments for an enrollment. - [Get production deployment](https://techdocs.akamai.com/cps/reference/get-deployments-production.md): Gets the enrollments deployed on the production network. - [Get staging deployment](https://techdocs.akamai.com/cps/reference/get-deployment-staging.md): Gets the enrollments deployed on the staging network. - [Get change status](https://techdocs.akamai.com/cps/reference/get-enrollment-change.md): Gets the status of a pending change. - [Cancel a change](https://techdocs.akamai.com/cps/reference/delete-enrollment-change.md): Cancels a pending change. This cancels the entire change. You can cancel any pending change you previously made to a certificate. - [Get a deployment schedule](https://techdocs.akamai.com/cps/reference/get-change-deployment-schedule.md): Gets the current deployment schedule settings describing when a change deploys to the network. - [Get a change](https://techdocs.akamai.com/cps/reference/get-change-allowed-input-param.md): Get detailed information of a pending change. Below is a sample where `allowedInput[].type` has the value `third-party-csr`. The acceptable `Accept` header depends on the value of the `allowedInput.type` for the Change instance. See [Change control](ref:change-input-content-type-mapping) for details. - [Update a change](https://techdocs.akamai.com/cps/reference/post-change-allowed-input-param.md): Updates a pending change. Below is a sample where `allowedInput[].type` has the value `third-party-cert-and-trust-chain`. The acceptable `Content-Type` and `Accept` headers depends on the value of the `allowedInput.type` for the Change instance. See [Change control](ref:change-input-content-type-mapping) for details. - [Get change history](https://techdocs.akamai.com/cps/reference/get-history-changes.md): Change history of an enrollment. - [List active certificates](https://techdocs.akamai.com/cps/reference/get-active-certificates.md): Lists enrollments with active certificates. Note that the rate limit for this operation is 10 requests per minute per account. For details, see [Rate limiting](ref:rate-limiting). ## Recipes - [Cancel a change](https://techdocs.akamai.com/cps/recipes/cancel-a-change.md) - [Create an enrollment](https://techdocs.akamai.com/cps/recipes/create-an-enrollment.md) - [Get a change](https://techdocs.akamai.com/cps/recipes/get-a-change.md) - [Get a deployment schedule](https://techdocs.akamai.com/cps/recipes/get-a-deployment-schedule.md) - [Get an enrollment](https://techdocs.akamai.com/cps/recipes/get-an-enrollment.md) - [Get certificate history](https://techdocs.akamai.com/cps/recipes/get-certificate-history.md) - [Get change status](https://techdocs.akamai.com/cps/recipes/get-change-status.md) - [Get production deployment](https://techdocs.akamai.com/cps/recipes/get-production-deployment.md) - [Get staging deployment](https://techdocs.akamai.com/cps/recipes/get-staging-deployment.md) - [List deployments](https://techdocs.akamai.com/cps/recipes/list-deployments.md) - [List enrollments](https://techdocs.akamai.com/cps/recipes/list-enrollments.md) - [Remove an enrollment](https://techdocs.akamai.com/cps/recipes/remove-an-enrollment.md) - [Update a change](https://techdocs.akamai.com/cps/recipes/update-a-change.md) - [Update a deployment schedule](https://techdocs.akamai.com/cps/recipes/update-a-deployment-schedule-1.md) - [Update an enrollment](https://techdocs.akamai.com/cps/recipes/update-an-enrollment.md) ## Changelog - [June 24, 2025 — Akamai-managed OV and EV root certificate transition to DigiCert G5 roots](https://techdocs.akamai.com/cps/changelog/june-24-2025-ov-ev-root-cert-transition-digicert-g5.md) - [April 23, 2025 — CPS: Security and technology stack up upgrade](https://techdocs.akamai.com/cps/changelog/apr-23-2025-security-tech-stack-up-upgrade.md) - [Apr 2, 2025 – CPS: DigiCert root selection update](https://techdocs.akamai.com/cps/changelog/apr-2-2025-cps-digicert-root-selection-update.md) - [Mar 6, 2025 – CPS: Default certificate chain update](https://techdocs.akamai.com/cps/changelog/mar-6-2025-cps-update.md) - [Feb 11, 2025 – CPS update: New DigiCert root certificate options](https://techdocs.akamai.com/cps/changelog/feb-11-2025-cps-update-new-digicert-root-certificate-options.md) # Client Access Control Documentation > Manage access between your web assets and the edge servers on the Akamai network. With Client Access Control you can retrieve information about the CIDR blocks that currently connect your content to the Akamai network. When Akamai updates the CIDR blocks used for access, use Client Access Control to review the changes and send an acknowledgement to Akamai once you update your Access Control List. ## Guides - [Welcome to Client Access Control](https://techdocs.akamai.com/client-access-control/docs/about-client-access-control.md) - [Overview of the Client Access Control configuration](https://techdocs.akamai.com/client-access-control/docs/ov-client-access-control-config.md) - [About CIDR blocks](https://techdocs.akamai.com/client-access-control/docs/about-cidr-blocks.md) - [Process overview](https://techdocs.akamai.com/client-access-control/docs/process-ov.md) - [Access the CIDR Lists application](https://techdocs.akamai.com/client-access-control/docs/access-cidr-lists-app.md) - [Review the CIDR List screen fields](https://techdocs.akamai.com/client-access-control/docs/review-cidr-list-screen-fields.md) - [Review and download proposed CIDR Lists](https://techdocs.akamai.com/client-access-control/docs/review-dl-proposed-cidr-lists.md) - [Update the CIDR Lists on your network](https://techdocs.akamai.com/client-access-control/docs/update-cidr-lists-network.md) - [Acknowledge that you have updated the CIDR Lists](https://techdocs.akamai.com/client-access-control/docs/acknowledge-have-updated-cidr-lists.md) ## API Reference - [Client Access Control API](https://techdocs.akamai.com/client-access-control/reference/api.md) - [API Summary](https://techdocs.akamai.com/client-access-control/reference/api-summary.md) - [Get started](https://techdocs.akamai.com/client-access-control/reference/get-started.md) - [API concepts](https://techdocs.akamai.com/client-access-control/reference/api-concepts.md) - [Errors](https://techdocs.akamai.com/client-access-control/reference/errors.md) - [400](https://techdocs.akamai.com/client-access-control/reference/400.md) - [401](https://techdocs.akamai.com/client-access-control/reference/401.md) - [403](https://techdocs.akamai.com/client-access-control/reference/403.md) - [404](https://techdocs.akamai.com/client-access-control/reference/404.md) - [405](https://techdocs.akamai.com/client-access-control/reference/405.md) - [406](https://techdocs.akamai.com/client-access-control/reference/406.md) - [500](https://techdocs.akamai.com/client-access-control/reference/500.md) - [List CAC configurations](https://techdocs.akamai.com/client-access-control/reference/get-configurations.md): Lists all Client Access Control (CAC) configurations you can access. - [Get a CAC configuration](https://techdocs.akamai.com/client-access-control/reference/get-configuration.md): Returns the Client Access Control (CAC) configuration for a specific `configurationId`. - [Acknowledge proposed CIDR blocks](https://techdocs.akamai.com/client-access-control/reference/put-configuration-acknowledge-version.md): Acknowledges the change. Use it once you review the `proposedCidrs` from Akamai and update your Access Control List (ACL) accordingly. ## Changelog - [Jan 11, 2022 — New Client Access Control documentation experience](https://techdocs.akamai.com/client-access-control/changelog/jan-11-2022-new-client-access-control-documentation-experience.md) # Cloud Access Manager Documentation > Akamai's Cloud Access Manager enables cloud origin authentication and allows you to securely store and manage your cloud origin credentials in the form of access keys. ## Guides - [Welcome to Cloud Access Manager](https://techdocs.akamai.com/cloud-access-mgr/docs/welcome-cloud-access-mgr.md) - [Cloud origin authentication](https://techdocs.akamai.com/cloud-access-mgr/docs/cloud-origin-auth.md) - [Key concepts and terms](https://techdocs.akamai.com/cloud-access-mgr/docs/key-concepts-terms.md) - [Manage permissions](https://techdocs.akamai.com/cloud-access-mgr/docs/manage-permissions.md) - [Get authentication details](https://techdocs.akamai.com/cloud-access-mgr/docs/get-auth-details.md) - [Create an access key](https://techdocs.akamai.com/cloud-access-mgr/docs/create-access-key.md) - [Access key access control](https://techdocs.akamai.com/cloud-access-mgr/docs/access-key-control.md) - [Configure property to sign requests with access key](https://techdocs.akamai.com/cloud-access-mgr/docs/config-signing-property.md) - [Rotate an access key](https://techdocs.akamai.com/cloud-access-mgr/docs/rotate-access-key.md) - [Delete an access key or an access key version](https://techdocs.akamai.com/cloud-access-mgr/docs/delete-key-version.md) - [Edit an access key name](https://techdocs.akamai.com/cloud-access-mgr/docs/rename-access-key.md) - [Best practices](https://techdocs.akamai.com/cloud-access-mgr/docs/best-practices.md) ## API Reference - [Cloud Access Manager API](https://techdocs.akamai.com/cloud-access-mgr/reference/api.md) - [API summary](https://techdocs.akamai.com/cloud-access-mgr/reference/api-summary.md) - [Get started](https://techdocs.akamai.com/cloud-access-mgr/reference/get-started.md) - [Concepts](https://techdocs.akamai.com/cloud-access-mgr/reference/concepts.md) - [Hypermedia](https://techdocs.akamai.com/cloud-access-mgr/reference/hypermedia.md) - [Rate limiting](https://techdocs.akamai.com/cloud-access-mgr/reference/rate-limiting.md) - [Resource limiting](https://techdocs.akamai.com/cloud-access-mgr/reference/resource-limiting.md) - [Asynchronous requests](https://techdocs.akamai.com/cloud-access-mgr/reference/asynchronous-requests.md) - [Usage examples](https://techdocs.akamai.com/cloud-access-mgr/reference/usage-examples.md) - [Errors](https://techdocs.akamai.com/cloud-access-mgr/reference/errors.md) - [400](https://techdocs.akamai.com/cloud-access-mgr/reference/400.md) - [401](https://techdocs.akamai.com/cloud-access-mgr/reference/401.md) - [403](https://techdocs.akamai.com/cloud-access-mgr/reference/403.md) - [404](https://techdocs.akamai.com/cloud-access-mgr/reference/404.md) - [405](https://techdocs.akamai.com/cloud-access-mgr/reference/405.md) - [409](https://techdocs.akamai.com/cloud-access-mgr/reference/409.md) - [415](https://techdocs.akamai.com/cloud-access-mgr/reference/415.md) - [429](https://techdocs.akamai.com/cloud-access-mgr/reference/429.md) - [500](https://techdocs.akamai.com/cloud-access-mgr/reference/500.md) - [501](https://techdocs.akamai.com/cloud-access-mgr/reference/501.md) - [502](https://techdocs.akamai.com/cloud-access-mgr/reference/502.md) - [503](https://techdocs.akamai.com/cloud-access-mgr/reference/503.md) - [Create an access key](https://techdocs.akamai.com/cloud-access-mgr/reference/post-access-key.md): Creates a new access key. An access key's name needs to be unique within a user account. Once an access key has been created, it's available on both the staging and production Akamai networks. - [List access keys](https://techdocs.akamai.com/cloud-access-mgr/reference/get-access-keys.md): Returns detailed information about all access keys available to the current user account. - [Get an access key](https://techdocs.akamai.com/cloud-access-mgr/reference/get-access-key.md): Returns details for a specific access key. - [Update an access key](https://techdocs.akamai.com/cloud-access-mgr/reference/put-access-key.md): Updates an access key's name. - [Delete an access key](https://techdocs.akamai.com/cloud-access-mgr/reference/delete-access-key.md): Deletes a specific access key. - [Create an access key version](https://techdocs.akamai.com/cloud-access-mgr/reference/post-access-key-version.md): Rotates an access key to a new version. You should only need to do this if your cloud provider credentials have changed, for example because they've expired or been compromised. Only two versions of an access key can exist and be active at the same time. If you have two access key versions you have to [delete](ref:delete-access-key-version) one of them before you can create another version. - [List access key versions](https://techdocs.akamai.com/cloud-access-mgr/reference/get-access-key-versions.md): Returns detailed information about all of the versions for a specific access key. - [Get an access key version](https://techdocs.akamai.com/cloud-access-mgr/reference/get-access-key-version.md): Returns detailed information for a specific version of an access key. - [Delete an access key version](https://techdocs.akamai.com/cloud-access-mgr/reference/delete-access-key-version.md): Deletes a specific version of an access key. This operation works asynchronously. If you receive a successful 202 response, the request has been accepted and it's been added to the queue for deletion. You can use the `Location` header that's returned in the response to check the status of the request. You can't delete an access key version if it is still in use. - [Look up properties](https://techdocs.akamai.com/cloud-access-mgr/reference/get-access-key-version-properties.md): Returns information about all of the Property Manager properties that use a specific version of an access key. This operation gets the data directly. To avoid any latency problems, run the [Perform a property lookup request asynchronously](ref:get-property-lookup) operation. - [Get an ID for an asynchronous property lookup request](https://techdocs.akamai.com/cloud-access-mgr/reference/get-async-version-property-lookup.md): Get the unique identifier used to perform an [asynchronous property lookup request](ref:get-property-lookup). - [Perform a property lookup request asynchronously](https://techdocs.akamai.com/cloud-access-mgr/reference/get-property-lookup.md): Provides functionality similar to the [Perform a property lookup request](ref:get-access-key-version-properties) operation, but accesses the data asynchronously after running the [Get an ID for an asynchronous property lookup request](ref:get-async-version-property-lookup) operation to obtain the `lookupId`. - [Get the status of an access key version](https://techdocs.akamai.com/cloud-access-mgr/reference/get-access-key-version-create-request.md): Returns the current status and other details for a request to create a new access key version. - [Get the status of an access key](https://techdocs.akamai.com/cloud-access-mgr/reference/get-access-key-create-request.md): Returns the current status and other details for a request to create a new access key. ## Recipes - [Create an access key version](https://techdocs.akamai.com/cloud-access-mgr/recipes/create-an-access-key-version.md) - [Create an access key](https://techdocs.akamai.com/cloud-access-mgr/recipes/create-an-access-key.md) - [Delete an access key version](https://techdocs.akamai.com/cloud-access-mgr/recipes/delete-an-access-key-version.md) - [Get an access key version](https://techdocs.akamai.com/cloud-access-mgr/recipes/get-an-access-key-version.md) - [Get an access key](https://techdocs.akamai.com/cloud-access-mgr/recipes/get-an-access-key.md) - [Get an ID for an asynchronous property lookup request](https://techdocs.akamai.com/cloud-access-mgr/recipes/get-an-id-for-an-asynchronous-property-lookup-request.md) - [Get the status of an access key job](https://techdocs.akamai.com/cloud-access-mgr/recipes/get-the-status-of-an-access-key-job.md) - [Get the status of an access key version job](https://techdocs.akamai.com/cloud-access-mgr/recipes/get-the-status-of-an-access-key-version-job.md) - [List access key versions](https://techdocs.akamai.com/cloud-access-mgr/recipes/list-access-key-versions.md) - [List access keys](https://techdocs.akamai.com/cloud-access-mgr/recipes/list-access-keys.md) - [Perform a property lookup request asynchronously](https://techdocs.akamai.com/cloud-access-mgr/recipes/perform-a-property-lookup-request-asynchronously.md) - [Perform a property lookup request](https://techdocs.akamai.com/cloud-access-mgr/recipes/perform-a-property-lookup-request.md) ## Changelog - [May 22, 2024 — New UI launched](https://techdocs.akamai.com/cloud-access-mgr/changelog/may-22-2024.md) - [Feb 5, 2024 — Edit access key name](https://techdocs.akamai.com/cloud-access-mgr/changelog/feb-5-2024-edit-key-name.md) - [Dec 1, 2023 — Access key deletion](https://techdocs.akamai.com/cloud-access-mgr/changelog/dec-1-2023-delete-access-key.md) - [Mar 14, 2023 — Postman collection available](https://techdocs.akamai.com/cloud-access-mgr/changelog/march-14-2022-postman-collection-available.md) - [Dec 2, 2021 — New Cloud Access Manager documentation experience](https://techdocs.akamai.com/cloud-access-mgr/changelog/dec-2-2021-new-cloud-access-manager-documentation-experience.md) # Cloud Wrapper Documentation > Akamai's Cloud Wrapper optimizes connectivity between cloud infrastructures and the Akamai Intelligent Edge. It uses custom caching to reduce origin requests and the cost to distribute content from the cloud. If you have a high volume of end-user requests, Cloud Wrapper can help provide consistent, high-quality experiences. ## Guides - [Welcome to Cloud Wrapper](https://techdocs.akamai.com/cloud-wrapper/docs/getting-started.md) - [How Cloud Wrapper works](https://techdocs.akamai.com/cloud-wrapper/docs/how-cloud-wrapper-works.md) - [Key concepts and terms](https://techdocs.akamai.com/cloud-wrapper/docs/key-concepts-and-terms.md) - [Set up and optimize delivery](https://techdocs.akamai.com/cloud-wrapper/docs/optimize-your-property.md) - [Determine your requirements](https://techdocs.akamai.com/cloud-wrapper/docs/get-started-with-cloud-wrapper.md) - [Add a configuration](https://techdocs.akamai.com/cloud-wrapper/docs/add-a-cloud-wrapper-configuration.md) - [Multi CDN tasks](https://techdocs.akamai.com/cloud-wrapper/docs/multi-cdn-tasks.md) - [Activate a configuration](https://techdocs.akamai.com/cloud-wrapper/docs/activate-a-cloud-wrapper-configuration.md) - [Add the Cloud Wrapper behavior](https://techdocs.akamai.com/cloud-wrapper/docs/add-a-cloud-wrapper-behavior.md) - [Manage your configurations](https://techdocs.akamai.com/cloud-wrapper/docs/manage-your-cloud-wrapper-configurations.md) - [View an audit trail](https://techdocs.akamai.com/cloud-wrapper/docs/view-an-audit-trail.md) - [View the dashboard](https://techdocs.akamai.com/cloud-wrapper/docs/cloud-wrapper-dashboard.md) - [View your capacity inventory](https://techdocs.akamai.com/cloud-wrapper/docs/view-your-capacity-inventory.md) - [FAQ and considerations](https://techdocs.akamai.com/cloud-wrapper/docs/faq-and-considerations.md) - [Cloud Wrapper reports](https://techdocs.akamai.com/cloud-wrapper/docs/cloud-wrapper-reports.md) ## API Reference - [Cloud Wrapper Configuration API](https://techdocs.akamai.com/cloud-wrapper/reference/api.md) - [API summary](https://techdocs.akamai.com/cloud-wrapper/reference/api-summary.md) - [Get started](https://techdocs.akamai.com/cloud-wrapper/reference/get-started-with-the-cloud-wrapper-configuration-api.md) - [Concepts](https://techdocs.akamai.com/cloud-wrapper/reference/concepts.md) - [Rate limiting](https://techdocs.akamai.com/cloud-wrapper/reference/rate-limiting.md) - [API hypermedia](https://techdocs.akamai.com/cloud-wrapper/reference/api-hypermedia.md) - [Errors](https://techdocs.akamai.com/cloud-wrapper/reference/errors.md) - [400](https://techdocs.akamai.com/cloud-wrapper/reference/400.md) - [401](https://techdocs.akamai.com/cloud-wrapper/reference/401.md) - [403](https://techdocs.akamai.com/cloud-wrapper/reference/403.md) - [404](https://techdocs.akamai.com/cloud-wrapper/reference/404.md) - [405](https://techdocs.akamai.com/cloud-wrapper/reference/405.md) - [415](https://techdocs.akamai.com/cloud-wrapper/reference/415.md) - [429](https://techdocs.akamai.com/cloud-wrapper/reference/429.md) - [500](https://techdocs.akamai.com/cloud-wrapper/reference/500.md) - [List capacity](https://techdocs.akamai.com/cloud-wrapper/reference/get-capacity-inventory.md): View the capacities available for a given `contractId`. - [List properties](https://techdocs.akamai.com/cloud-wrapper/reference/get-properties.md): View a list of properties for delivery products that are eligible to enable Cloud Wrapper. - [List origins](https://techdocs.akamai.com/cloud-wrapper/reference/get-origins.md): View a list of [origin](https://techdocs.akamai.com/property-mgr/reference/latest-origin) servers configured in eligible delivery properties. The API pulls response data from the property as it's shown in PAPI. At least one origin server entry is shown at the top-level for the `default` rule. If additional origin servers are set in child-level rules in the same property, they're revealed at a lower level. - [List locations](https://techdocs.akamai.com/cloud-wrapper/reference/get-locations.md): View the locations available to distribute your Cloud Wrapper capacity. This operation lists the available `trafficTypeId` values for use when creating configurations. - [Create a configuration](https://techdocs.akamai.com/cloud-wrapper/reference/post-configuration.md): Create a Cloud Wrapper configuration. > 📘 > > You first need to work with your account team to include Cloud Wrapper locations and capacity on your contract. Verify your capacity by viewing your [capacity inventory](ref:get-capacity-inventory). - [List configurations](https://techdocs.akamai.com/cloud-wrapper/reference/get-configurations.md): List all of the Cloud Wrapper configurations on your contract. - [Activate a configuration](https://techdocs.akamai.com/cloud-wrapper/reference/post-configuration-activations.md): Activate a Cloud Wrapper configuration. It takes 3-4 hours for the configuration to complete. You can use the configuration's `configId` to run the [Get a configuration](ref:get-configuration) operation and review its `status`. Once it's `ACTIVE`, [enable the Cloud Wrapper behavior](https://techdocs.akamai.com/cloud-wrapper/docs/add-a-cloud-wrapper-behavior#enable-the-cloud-wrapper-behavior) in your property. To deactivate a configuration, [update it](ref:put-configuration) and set the `activate` query string to `false`. - [Get a configuration](https://techdocs.akamai.com/cloud-wrapper/reference/get-configuration.md): View a specific Cloud Wrapper configuration. - [Update a configuration](https://techdocs.akamai.com/cloud-wrapper/reference/put-configuration.md): Update a saved or inactive configuration. - [Delete a configuration](https://techdocs.akamai.com/cloud-wrapper/reference/delete-configuration.md): Delete a specific Cloud Wrapper configuration. The delete can take up to three hours to complete. You can use the configuration's `configId` to run the [Get a configuration](ref:get-configuration) operation to check the status. `DELETE_IN_PROGRESS` indicates the API accepted the request and it's processing the delete. A 404 response indicates the API has deleted the configuration. > 🚧 Before you delete a configuration: > > Ensure that all the properties that use it have the [`cloudWrapper`](https://techdocs.akamai.com/property-mgr/reference/latest-cloud-wrapper) behavior disabled. Then [update](ref:put-configuration) the configuration to deactivate it by setting the `activate` query string to `false`. - [List auth keys](https://techdocs.akamai.com/cloud-wrapper/reference/get-auth-keys.md): This operation shows the `cdnAuthKeys` for a specific Akamai `contractId` and specific third-party CDN (`cdnCode`). Use [auth keys](ref:concepts) (`cdnAuthKeys`) to generate the header that authenticates a request between a third-party CDN and your Cloud Wrapper cache, on the Akamai CDN. - [Get origin hostnames for a configuration](https://techdocs.akamai.com/cloud-wrapper/reference/get-origin-hostnames.md): View the origin hostnames for a specific configuration. - [List CDN providers](https://techdocs.akamai.com/cloud-wrapper/reference/get-providers.md): View a list of CDN providers. ## Recipes - [CW: Activate a configuration](https://techdocs.akamai.com/cloud-wrapper/recipes/cw-activate-a-configuration.md) - [CW: Create a basic configuration](https://techdocs.akamai.com/cloud-wrapper/recipes/cw-create-a-basic-configuration.md) - [CW: Create a multi-CDN configuration](https://techdocs.akamai.com/cloud-wrapper/recipes/cw-create-a-multi-cdn-configuration.md) - [CW: Delete a configuration](https://techdocs.akamai.com/cloud-wrapper/recipes/cw-delete-a-configuration.md) - [CW: Get a configuration](https://techdocs.akamai.com/cloud-wrapper/recipes/cw-get-a-configuration.md) - [CW: Get origin hostnames for a configuration](https://techdocs.akamai.com/cloud-wrapper/recipes/cw-get-origin-hostnames-for-a-configuration.md) - [CW: List auth keys](https://techdocs.akamai.com/cloud-wrapper/recipes/cw-list-auth-keys.md) - [CW: List capacity](https://techdocs.akamai.com/cloud-wrapper/recipes/cw-list-capacity.md) - [CW: List CDN providers](https://techdocs.akamai.com/cloud-wrapper/recipes/cw-list-cdn-providers.md) - [CW: List configurations](https://techdocs.akamai.com/cloud-wrapper/recipes/cw-list-configurations.md) - [CW: List locations](https://techdocs.akamai.com/cloud-wrapper/recipes/cw-list-locations.md) - [CW: List origins](https://techdocs.akamai.com/cloud-wrapper/recipes/cw-list-origins.md) - [CW: List properties](https://techdocs.akamai.com/cloud-wrapper/recipes/cw-list-properties.md) - [CW: Update a configuration](https://techdocs.akamai.com/cloud-wrapper/recipes/cw-update-a-configuration.md) ## Changelog - [Oct 8, 2024 – Update to Origin IP ACL support](https://techdocs.akamai.com/cloud-wrapper/changelog/oct-8-2024-update-to-origin-ip-acl-support.md) - [Oct 1, 2024 — Web delivery product support (LA)](https://techdocs.akamai.com/cloud-wrapper/changelog/oct-1-2024-web-delivery-product-support-la.md) - [Oct 31, 2023 — New reporting interface](https://techdocs.akamai.com/cloud-wrapper/changelog/oct-31-2023-new-reporting-interface.md) - [Sep 19, 2023 — Recipes for API operations](https://techdocs.akamai.com/cloud-wrapper/changelog/sep-19-2023-recipes-for-api-operations.md) - [Jun 7, 2023 — Retain idle objects support](https://techdocs.akamai.com/cloud-wrapper/changelog/jun-7-2023-retain-idle-objects-support.md) # Cloudlets Documentation > Akamai's Cloudlets are value-added applications that complement Akamai’s core delivery solutions to solve specific business challenges. Cloudlets bring a site’s business logic closer to the end user by placing it on the edge of the content delivery platform. ## Guides - [Welcome to Cloudlets](https://techdocs.akamai.com/cloudlets/docs/welcome-cloudlets.md) - [How Cloudlets work](https://techdocs.akamai.com/cloudlets/docs/how-cloudlets-work.md) - [Available Cloudlets](https://techdocs.akamai.com/cloudlets/docs/available-cloudlets.md) - [Key concepts and terms](https://techdocs.akamai.com/cloudlets/docs/cloudlets-terminology.md) - [Property and Cloudlet policy considerations](https://techdocs.akamai.com/cloudlets/docs/prop-cloudlet-policy-consid.md) - [Interactions between Cloudlet behaviors in Property Manager](https://techdocs.akamai.com/cloudlets/docs/interactions-between-cloudlet-behaviors-in-property-manager.md) - [Who should manage your Cloudlets](https://techdocs.akamai.com/cloudlets/docs/who-should-manage-cloudlets.md) - [Image and Video Manager and Cloudlets](https://techdocs.akamai.com/cloudlets/docs/ivm-cloudlets-interop.md) - [Get started with Cloudlets](https://techdocs.akamai.com/cloudlets/docs/get-started-cloudlets.md) - [Basic Cloudlet configuration](https://techdocs.akamai.com/cloudlets/docs/gs-basic-cloudlet-config.md) - [Cloudlets that forward to different origins](https://techdocs.akamai.com/cloudlets/docs/gs-cloudlets-forward-diff-origins.md) - [Application Load Balancer Cloudlet](https://techdocs.akamai.com/cloudlets/docs/gs-app-load-balancer-cloudlet.md) - [Manage Cloudlet policies and policy versions](https://techdocs.akamai.com/cloudlets/docs/manage-cloudlet-policies-policy-versions.md) - [Create a Cloudlet policy](https://techdocs.akamai.com/cloudlets/docs/create-cloudlet-policy.md) - [Manage Cloudlets policies](https://techdocs.akamai.com/cloudlets/docs/manage-cloudlets-policies.md) - [Upgrade to Shared Policy](https://techdocs.akamai.com/cloudlets/docs/upgrade-shared-policy.md) - [Create a Cloudlet policy version](https://techdocs.akamai.com/cloudlets/docs/create-cloudlet-policy-version.md) - [Manage Cloudlets policy versions](https://techdocs.akamai.com/cloudlets/docs/manage-cloudlets-policy-versions.md) - [Remove a property association from a policy](https://techdocs.akamai.com/cloudlets/docs/remove-property-association.md) - [Cloudlets rules](https://techdocs.akamai.com/cloudlets/docs/cloudlets-rules.md) - [General rules considerations](https://techdocs.akamai.com/cloudlets/docs/general-rules-consid.md) - [Cloudlet rule structure](https://techdocs.akamai.com/cloudlets/docs/cloudlet-rule-structure.md) - [Add rules by Cloudlet type](https://techdocs.akamai.com/cloudlets/docs/add-rules-cloudlet-type.md) - [Manage Cloudlet rules](https://techdocs.akamai.com/cloudlets/docs/manage-cloudlet-rules.md) - [Review rule order](https://techdocs.akamai.com/cloudlets/docs/review-rule-order.md) - [Upload rule in CSV format](https://techdocs.akamai.com/cloudlets/docs/upload-rule-csv-format.md) - [Download rules in CSV format](https://techdocs.akamai.com/cloudlets/docs/dl-rules-csv-format.md) - [Cost limit](https://techdocs.akamai.com/cloudlets/docs/cost-limit.md) - [Activate a Cloudlets policy](https://techdocs.akamai.com/cloudlets/docs/activating-cloudlets-policy.md) - [Activate a Cloudlets policy version](https://techdocs.akamai.com/cloudlets/docs/activate-cloudlets-policy-version.md) - [View activation details](https://techdocs.akamai.com/cloudlets/docs/view-activation-details.md) - [Activation statuses for Cloudlets policies](https://techdocs.akamai.com/cloudlets/docs/activation-statuses-cloudlets-policies.md) - [Where you can activate from](https://techdocs.akamai.com/cloudlets/docs/where-can-activate.md) - [Activate the property](https://techdocs.akamai.com/cloudlets/docs/activate-cloudlets-beh-prop-manager.md) - [Cloudlet activation times](https://techdocs.akamai.com/cloudlets/docs/activation-times.md) - [Cloudlets match types](https://techdocs.akamai.com/cloudlets/docs/cloudlets-match-types.md) - [Available match types](https://techdocs.akamai.com/cloudlets/docs/available-match-types.md) - [Match matrix](https://techdocs.akamai.com/cloudlets/docs/match-matrix.md) - [Cookie](https://techdocs.akamai.com/cloudlets/docs/cookie.md) - [Default](https://techdocs.akamai.com/cloudlets/docs/default.md) - [Device Characteristics](https://techdocs.akamai.com/cloudlets/docs/device-charac.md) - [File extension](https://techdocs.akamai.com/cloudlets/docs/file-ext.md) - [Hostname](https://techdocs.akamai.com/cloudlets/docs/hostname.md) - [IP address/CIDR list](https://techdocs.akamai.com/cloudlets/docs/ip-addr-cidr-list.md) - [Protocol](https://techdocs.akamai.com/cloudlets/docs/protocol.md) - [Proxy](https://techdocs.akamai.com/cloudlets/docs/proxy.md) - [Query string](https://techdocs.akamai.com/cloudlets/docs/query-string.md) - [Range](https://techdocs.akamai.com/cloudlets/docs/range.md) - [Request header](https://techdocs.akamai.com/cloudlets/docs/req-header.md) - [Request method](https://techdocs.akamai.com/cloudlets/docs/req-method.md) - [URL path](https://techdocs.akamai.com/cloudlets/docs/url-path.md) - [URL regular expression](https://techdocs.akamai.com/cloudlets/docs/url-regexp.md) - [User location data](https://techdocs.akamai.com/cloudlets/docs/user-loc-data.md) - [Regular expressions with Cloudlets rules](https://techdocs.akamai.com/cloudlets/docs/regex-cloudlets-rules.md) - [About Conditional Origins](https://techdocs.akamai.com/cloudlets/docs/about-conditional-origins.md) - [Purge alternate response pages](https://techdocs.akamai.com/cloudlets/docs/purge-alternate-response-pages.md) - [Configure permissions for Cloudlets](https://techdocs.akamai.com/cloudlets/docs/config-permissions-cloudlets.md) - [About Application Load Balancer](https://techdocs.akamai.com/cloudlets/docs/what-app-load-balancer.md) - [How failover works for Application Load Balancer](https://techdocs.akamai.com/cloudlets/docs/how-does-failover-work-app-load-balancer.md) - [Review Application Load Balancer setup tasks](https://techdocs.akamai.com/cloudlets/docs/review-app-load-balancer-setup-tasks.md) - [Set up a maintenance page](https://techdocs.akamai.com/cloudlets/docs/setup-maintenance-page.md) - [Set up load balancing configurations](https://techdocs.akamai.com/cloudlets/docs/setup-load-balancing-config.md) - [Create an Application Load Balancer policy](https://techdocs.akamai.com/cloudlets/docs/create-application-load-balancer-policy.md) - [Review available match types for Application Load Balancer](https://techdocs.akamai.com/cloudlets/docs/review-available-match-types-app-load-balancer.md) - [Add an Application Load Balancer rule](https://techdocs.akamai.com/cloudlets/docs/add-app-load-balancer-rule.md) - [Configure the Application Load Balancer behavior](https://techdocs.akamai.com/cloudlets/docs/config-app-load-balancer-beh.md) - [Migrating Data Center](https://techdocs.akamai.com/cloudlets/docs/migrating-data-center.md) - [Reporting - Application Load Balancer](https://techdocs.akamai.com/cloudlets/docs/reporting-alb.md) - [Delete a load balancing configuration](https://techdocs.akamai.com/cloudlets/docs/delete-load-balancing-config.md) - [About API Prioritization](https://techdocs.akamai.com/cloudlets/docs/what-api-prioritization.md) - [Review API Prioritization setup tasks](https://techdocs.akamai.com/cloudlets/docs/review-api-prioritization-setup-tasks.md) - [Create an API Prioritization policy](https://techdocs.akamai.com/cloudlets/docs/create-api-prioritization-policy.md) - [Review available match types for API Prioritization](https://techdocs.akamai.com/cloudlets/docs/review-available-match-types-api-prioritization.md) - [Add an API Prioritization rule](https://techdocs.akamai.com/cloudlets/docs/add-api-prioritization-rule.md) - [Configure the API Prioritization behavior](https://techdocs.akamai.com/cloudlets/docs/config-api-prioritization-beh.md) - [About Audience Segmentation](https://techdocs.akamai.com/cloudlets/docs/what-audience-segmentation.md) - [Review Audience Segmentation setup tasks](https://techdocs.akamai.com/cloudlets/docs/review-audience-segmentation-setup-tasks.md) - [Create an Audience Segmentation policy](https://techdocs.akamai.com/cloudlets/docs/create-audience-segmentation-policy.md) - [Review available match types for Audience Segmentation](https://techdocs.akamai.com/cloudlets/docs/review-available-match-types-audience-segmentation.md) - [Add an Audience Segmentation rule](https://techdocs.akamai.com/cloudlets/docs/add-audience-segmentation-rule.md) - [Configure the Audience Segmentation behavior](https://techdocs.akamai.com/cloudlets/docs/config-audience-segmentation-beh.md) - [About Edge Redirector](https://techdocs.akamai.com/cloudlets/docs/what-edge-redirector.md) - [Review Edge Redirector setup tasks](https://techdocs.akamai.com/cloudlets/docs/review-edge-redirector-setup-tasks.md) - [Create an Edge Redirector policy](https://techdocs.akamai.com/cloudlets/docs/create-edge-redirector-policy.md) - [Review available match types for Edge Redirector](https://techdocs.akamai.com/cloudlets/docs/review-available-match-types-edge-redirector.md) - [Add Edge Redirector rules](https://techdocs.akamai.com/cloudlets/docs/add-edge-redirector-rules.md) - [Configure the Edge Redirector behavior](https://techdocs.akamai.com/cloudlets/docs/config-edge-redirector-beh.md) - [Reporting - Edge Redirector](https://techdocs.akamai.com/cloudlets/docs/reporting-edge-redirector.md) - [About Forward Rewrite](https://techdocs.akamai.com/cloudlets/docs/what-forward-rewrite.md) - [Review Forward Rewrite setup tasks](https://techdocs.akamai.com/cloudlets/docs/review-forward-rewrite-setup-tasks.md) - [Create a Forward Rewrite policy](https://techdocs.akamai.com/cloudlets/docs/create-forward-rewrite-policy.md) - [Review available match types for Forward Rewrite](https://techdocs.akamai.com/cloudlets/docs/review-available-match-types-forward-rewrite.md) - [Add a Forward Rewrite rule](https://techdocs.akamai.com/cloudlets/docs/add-forward-rewrite-rule.md) - [Configure the Forward Rewrite behavior](https://techdocs.akamai.com/cloudlets/docs/configure-forward-rewrite-beh.md) - [About Phased Release](https://techdocs.akamai.com/cloudlets/docs/what-is-phased-release.md) - [Review Phased Release setup tasks](https://techdocs.akamai.com/cloudlets/docs/review-phased-release-setup-tasks.md) - [Create a Phased Release policy](https://techdocs.akamai.com/cloudlets/docs/create-phased-release-policy.md) - [Review available match types for Phased Release](https://techdocs.akamai.com/cloudlets/docs/review-available-match-types-phased-release.md) - [Add a Phased Release rule](https://techdocs.akamai.com/cloudlets/docs/add-phased-release-rule.md) - [Configure the Phased Release behavior](https://techdocs.akamai.com/cloudlets/docs/config-phased-release-beh.md) - [About Request Control](https://techdocs.akamai.com/cloudlets/docs/what-req-control.md) - [Review Request Control setup tasks](https://techdocs.akamai.com/cloudlets/docs/review-req-control-setup-tasks.md) - [Create a Request Control policy](https://techdocs.akamai.com/cloudlets/docs/create-request-control-policy.md) - [Review available match types for Request Control](https://techdocs.akamai.com/cloudlets/docs/review-available-match-types-req-control.md) - [Add a Request Control rule](https://techdocs.akamai.com/cloudlets/docs/add-req-control-rule.md) - [Configure the Request Control behavior](https://techdocs.akamai.com/cloudlets/docs/config-req-control-beh.md) - [About Visitor Prioritization](https://techdocs.akamai.com/cloudlets/docs/what-visitor-prioritization.md) - [Review Visitor Prioritization setup tasks](https://techdocs.akamai.com/cloudlets/docs/review-visitor-prioritization-setup-tasks.md) - [Create a Visitor Prioritization policy](https://techdocs.akamai.com/cloudlets/docs/create-visitor-prioritization-policy.md) - [Set up a waiting room page](https://techdocs.akamai.com/cloudlets/docs/setup-waiting-room-page.md) - [Review available match types for Visitor Prioritization](https://techdocs.akamai.com/cloudlets/docs/review-available-match-types-visitor-prioritization.md) - [Add a Visitor Prioritization rule](https://techdocs.akamai.com/cloudlets/docs/add-visitor-prioritization-rule.md) - [Configure the Visitor Prioritization behavior](https://techdocs.akamai.com/cloudlets/docs/config-visitor-prioritization-beh.md) ## API Reference - [Cloudlets API v3](https://techdocs.akamai.com/cloudlets/reference/api.md) - [API summary](https://techdocs.akamai.com/cloudlets/reference/api-summary.md) - [Get started](https://techdocs.akamai.com/cloudlets/reference/get-started.md) - [Concepts](https://techdocs.akamai.com/cloudlets/reference/api-concepts.md) - [About group IDs](https://techdocs.akamai.com/cloudlets/reference/about-group-ids.md) - [API workflow](https://techdocs.akamai.com/cloudlets/reference/api-workflow.md) - [Activation status](https://techdocs.akamai.com/cloudlets/reference/activation-status.md) - [Match rules](https://techdocs.akamai.com/cloudlets/reference/match-rules.md) - [Match properties](https://techdocs.akamai.com/cloudlets/reference/match-properties.md) - [Rate limits](https://techdocs.akamai.com/cloudlets/reference/rate-limiting.md) - [Hypermedia](https://techdocs.akamai.com/cloudlets/reference/hypermedia.md) - [Errors](https://techdocs.akamai.com/cloudlets/reference/errors.md) - [400](https://techdocs.akamai.com/cloudlets/reference/400.md) - [401](https://techdocs.akamai.com/cloudlets/reference/401.md) - [403](https://techdocs.akamai.com/cloudlets/reference/403.md) - [404](https://techdocs.akamai.com/cloudlets/reference/404.md) - [409](https://techdocs.akamai.com/cloudlets/reference/409.md) - [429](https://techdocs.akamai.com/cloudlets/reference/429.md) - [500](https://techdocs.akamai.com/cloudlets/reference/500.md) - [List Cloudlets](https://techdocs.akamai.com/cloudlets/reference/get-cloudlets.md): Returns details for Cloudlets that you can [create a shared policy](ref:post-policy) for, including a Cloudlet name and Cloudlet type. - [Activate a policy version](https://techdocs.akamai.com/cloudlets/reference/post-policy-activations.md): Asynchronously activates or deactivates the selected Cloudlet policy version on the staging or production networks. When a policy version becomes active on the network, the previously active version gets automatically deactivated. Activating a policy version returns the `id` of the activation, which you can store and use to run the [Get status for an activation](ref:get-policy-activation) operation to check the status value. You can activate a policy on each network only after any previous activations have completed, otherwise you get a 409 error. - [List policy activations](https://techdocs.akamai.com/cloudlets/reference/get-policy-activations.md): Returns the complete activation history for the selected policy. - [Get status for an activation](https://techdocs.akamai.com/cloudlets/reference/get-policy-activation.md): Returns the status of an activation. See [Activation status](ref:activation-status). - [List shared policies](https://techdocs.akamai.com/cloudlets/reference/get-policies.md): Returns shared policies that are available within your group. - [Create a policy](https://techdocs.akamai.com/cloudlets/reference/post-policy.md): Creates a shared policy for a specific Cloudlet type. Currently, you can create a shared policy for the API Prioritization, Edge Redirector, Forward Rewrite, Request Control, Phased Release, and Audience Segmentation Cloudlets. You can then add match rules by [creating a policy version](ref:post-policy-version). If a policy already exists with the same policy name, you receive a 409 status response that contains data for the existing policy. - [Remove a policy](https://techdocs.akamai.com/cloudlets/reference/delete-policy.md): Deletes an existing Cloudlets policy. If you don't have the `policyId`, run the [List shared policies](ref:get-policies) operation and store the relevant `id` value. You can't delete a policy if any of its versions is active or being activated on the staging or production networks. - [Get a policy](https://techdocs.akamai.com/cloudlets/reference/get-policy.md): Returns information about a shared policy, including its activation status on the staging and production networks. If you don't already have the `policyId`, run the [List shared policies](ref:get-policies) operation and store the relevant `id` value. - [Update a policy](https://techdocs.akamai.com/cloudlets/reference/put-policy.md): Updates an existing policy. If you don't already have the `policyId`, run the [list shared policies](ref:get-policies) operation and store the relevant `id` value. - [Clone a policy as a shared policy](https://techdocs.akamai.com/cloudlets/reference/post-policy-clone.md): Clones the staging, production, and last modified versions of a non-shared (API v2) or shared policy into a new shared policy. You can also specify any additional versions that you want to clone into the new shared policy. The policy ID is required. If you don't already have the policy ID, use [List shared policies](ref:get-policies) or [List policies](https://techdocs.akamai.com/cloudlets/v2/reference/get-policies) and note the `id` or `policyId` value. When cloning a non-shared policy to a shared policy, a group ID (`groupId`) is required. Policies created using API v2 don't require a `groupId`, so the non-shared policy that you're cloning might not have this data field. If the policy you're cloning doesn’t have a `groupId`, assign one while performing this operation. To check if the non-shared policy has a `groupId`, see [List policies](https://techdocs.akamai.com/cloudlets/v2/reference/get-policies). - [Get active properties](https://techdocs.akamai.com/cloudlets/reference/get-policy-properties.md): Returns all active properties that are assigned to the policy. - [Create a policy version](https://techdocs.akamai.com/cloudlets/reference/post-policy-version.md): Creates a policy version, including match rules for a Cloudlet that you're using. If you don't already have the `policyId`, run the [List shared policies](ref:get-policies) operation and store the relevant `id` value. - [List policy versions](https://techdocs.akamai.com/cloudlets/reference/get-policy-versions.md): Returns information about all versions of a shared policy. - [Get a policy version](https://techdocs.akamai.com/cloudlets/reference/get-policy-version.md): Returns information about a shared policy version, including match rules for a Cloudlet that you're using and whether its locked for changes. - [Update a policy version](https://techdocs.akamai.com/cloudlets/reference/put-policy-version.md): Updates the description and match rules for a policy version. - [Remove a policy version](https://techdocs.akamai.com/cloudlets/reference/delete-policy-version.md): Deletes a version of a shared policy. You can't delete a policy if it's active on the staging or production network. When you remove a policy version, version numbers aren't reallocated. For example, a policy has 15 versions, and you delete versions 14 and 15. The next version created would be 16, not 14. ## Changelog - [Jul 16, 2026 - Cloudlets UI Update](https://techdocs.akamai.com/cloudlets/changelog/jul-16-2026-cloudlets-ui-update.md) - [May 26, 2026 — Cloudlets UI updates](https://techdocs.akamai.com/cloudlets/changelog/may-26-2026-cloudlets-ui-updates.md) - [Apr 23, 2026 — Cloudlets UI bug fixes](https://techdocs.akamai.com/cloudlets/changelog/apr-23-2026-cloudlets-bug-fixes.md) - [Mar 18, 2026 — Cloudlets UI updates](https://techdocs.akamai.com/cloudlets/changelog/mar-18-2026-cloudlets-ui-updates.md) - [Feb 19, 2026 — Cloudlets UI updates](https://techdocs.akamai.com/cloudlets/changelog/feb-19-2026-cloudlets-ui-updates.md) # CloudTest Documentation > Using Akamai's CloudTest to optimize your approach to load testing with a scalable, global platform. CloudTest provides testing capabilities for web and mobile apps, APIs, databases, and web services. Realtime analytics and customizable dashboards provide actionable intelligence, allowing for root-cause analysis while tests run. ## Guides - [Welcome to CloudTest](https://techdocs.akamai.com/cloudtest/docs/getting-started.md) - [About performance testing](https://techdocs.akamai.com/cloudtest/docs/load-testing.md): An overview of what performance testing is and the steps involved. - [License and professional service support](https://techdocs.akamai.com/cloudtest/docs/select-a-plan.md) - [Key concepts and terms](https://techdocs.akamai.com/cloudtest/docs/glossary.md) - [Navigate the user interface](https://techdocs.akamai.com/cloudtest/docs/navigate-the-user-interface.md) - [Start performance testing](https://techdocs.akamai.com/cloudtest/docs/start-performance-testing.md) - [Download recording tool](https://techdocs.akamai.com/cloudtest/docs/download-recording-tool.md) - [Record](https://techdocs.akamai.com/cloudtest/docs/record.md) - [Script](https://techdocs.akamai.com/cloudtest/docs/script-the-test.md) - [Compose](https://techdocs.akamai.com/cloudtest/docs/create-composition.md) - [Test and analyze](https://techdocs.akamai.com/cloudtest/docs/execute-your-test.md) - [Report](https://techdocs.akamai.com/cloudtest/docs/report-generation-analysis.md): When the test execution is complete you can generate reports and provide analysis of the data collected. - [Export](https://techdocs.akamai.com/cloudtest/docs/export-and-import.md) - [Updates](https://techdocs.akamai.com/cloudtest/docs/updates.md) - [Architecture of CloudTest](https://techdocs.akamai.com/cloudtest/docs/architecture-and-web-services.md) - [Message](https://techdocs.akamai.com/cloudtest/docs/message.md) - [Targets — types and options](https://techdocs.akamai.com/cloudtest/docs/targets-types-and-options.md) - [Create a new target](https://techdocs.akamai.com/cloudtest/docs/create-a-new-target.md) - [Edit target information](https://techdocs.akamai.com/cloudtest/docs/edit-target-information.md) - [Test clip](https://techdocs.akamai.com/cloudtest/docs/test-clip.md) - [Test composition](https://techdocs.akamai.com/cloudtest/docs/test-composition.md) - [Time delay](https://techdocs.akamai.com/cloudtest/docs/time-delay.md) - [SCommand Reference](https://techdocs.akamai.com/cloudtest/docs/scommand-reference-1.md) - [Load testing](https://techdocs.akamai.com/cloudtest/docs/load-testing-4.md) - [Architecture for load testing an application](https://techdocs.akamai.com/cloudtest/docs/architecture-for-load-testing-an-application.md) - [Cloud testing methodology](https://techdocs.akamai.com/cloudtest/docs/cloud-testing-methodology.md) - [Cloud preparation](https://techdocs.akamai.com/cloudtest/docs/cloud-preparation.md) - [CloudTest clip preparation](https://techdocs.akamai.com/cloudtest/docs/cloudtest-clip-preparation.md) - [Seed files](https://techdocs.akamai.com/cloudtest/docs/seed-files.md) - [CloudTest composition](https://techdocs.akamai.com/cloudtest/docs/cloudtest-composition.md) - [CloudTest grid](https://techdocs.akamai.com/cloudtest/docs/cloudtest-grid.md) - [Load testing](https://techdocs.akamai.com/cloudtest/docs/load-testing-3.md) - [Analytics](https://techdocs.akamai.com/cloudtest/docs/analytics.md) - [Summary](https://techdocs.akamai.com/cloudtest/docs/summary.md) - [Conclusion](https://techdocs.akamai.com/cloudtest/docs/conclusion-1.md) - [Reference](https://techdocs.akamai.com/cloudtest/docs/reference.md) - [Generate test traffic on the Cloud](https://techdocs.akamai.com/cloudtest/docs/generate-test-traffic-for-your-cloud-deployment.md) ## API Reference - [CloudTest API](https://techdocs.akamai.com/cloudtest/reference/api.md) - [API summary](https://techdocs.akamai.com/cloudtest/reference/api-summary.md) - [Get started](https://techdocs.akamai.com/cloudtest/reference/get-started.md) - [API concepts](https://techdocs.akamai.com/cloudtest/reference/api-concepts.md) - [Rate limiting](https://techdocs.akamai.com/cloudtest/reference/rate-limiting.md) - [Asynchronous operations](https://techdocs.akamai.com/cloudtest/reference/asynchronous-operations.md) - [Errors](https://techdocs.akamai.com/cloudtest/reference/errors.md) - [400](https://techdocs.akamai.com/cloudtest/reference/400.md) - [401](https://techdocs.akamai.com/cloudtest/reference/401.md) - [403](https://techdocs.akamai.com/cloudtest/reference/403.md) - [404](https://techdocs.akamai.com/cloudtest/reference/404.md) - [405](https://techdocs.akamai.com/cloudtest/reference/405.md) - [429](https://techdocs.akamai.com/cloudtest/reference/429.md) - [500](https://techdocs.akamai.com/cloudtest/reference/500.md) - [List cloud servers](https://techdocs.akamai.com/cloudtest/reference/get-cloud-servers.md): Returns an array of cloud servers. - [Get a cloud server](https://techdocs.akamai.com/cloudtest/reference/get-cloud-server.md): Returns a single cloud server. - [Restart or terminate a cloud server](https://techdocs.akamai.com/cloudtest/reference/post-cloud-server-action.md): Either `restart` or `terminate` a cloud server. The operation responds asynchronously with 202. See [Asynchronous operations](ref:asynchronous-operations) for details. - [Get a test environment](https://techdocs.akamai.com/cloudtest/reference/get-environment.md): Returns a single test environment. - [Start or stop a test environment](https://techdocs.akamai.com/cloudtest/reference/post-environment-action.md): Either `start` or `stop` a test environment. The operation responds either synchronously with a 200 code, or asynchronously with 202. See [Asynchronous operations](ref:asynchronous-operations) for details. - [List grids](https://techdocs.akamai.com/cloudtest/reference/get-grids.md): Returns an array of grids. Retrieves a list of Grids that have been started. It may include `TERMINATED` grids. It doesn't return grids that exist in the repository but are inactive. - [Get a grid](https://techdocs.akamai.com/cloudtest/reference/get-grid.md): Returns information about a single grid. - [Start or stop a grid](https://techdocs.akamai.com/cloudtest/reference/post-grid-action.md): Start or stop a grid. The operation responds either synchronously with a 200 code, or asynchronously with 202. See [Asynchronous operations](ref:asynchronous-operations) for details. - [Start or load a composition](https://techdocs.akamai.com/cloudtest/reference/post-composition.md): Start or load a test instance. - [List active compositions](https://techdocs.akamai.com/cloudtest/reference/get-compositions.md): Get all instances that are in some type of active state. After tests are complete the instances are unloaded and the API can no longer return them, these are considered inactive. Because this call uses an asynchronous process to get the list of instances, if there are many load generators you should run a second call to ensure you get the most complete list of instances. - [Get a composition](https://techdocs.akamai.com/cloudtest/reference/get-composition.md): Returns a single composition instance. - [Composition commands](https://techdocs.akamai.com/cloudtest/reference/put-composition-action.md): The composition commands you use on a test instance are: play, stop, abort, pause, resume, unload. The return of the command doesn't imply that the action is complete. To get the current state of the instance, use the [Get a composition](ref:get-composition) command. - [List objects](https://techdocs.akamai.com/cloudtest/reference/get-objects-attribute.md): Gets a list of repository objects, filtered by attributes. - [Create an object](https://techdocs.akamai.com/cloudtest/reference/put-object.md): Creates an object. - [Update an object](https://techdocs.akamai.com/cloudtest/reference/post-objects.md): Update a repository object. - [Get an object](https://techdocs.akamai.com/cloudtest/reference/get-object.md): Gets a repository object by type and ID. - [Delete an object](https://techdocs.akamai.com/cloudtest/reference/delete-objects.md): Delete a repository object. - [Transfer object ownership](https://techdocs.akamai.com/cloudtest/reference/post-mass-change-owner.md): Transfers the owner status for all entities within the Mains and CloudTest Manager (CTM) environments between users. - [Request a delete of test results](https://techdocs.akamai.com/cloudtest/reference/post-result-delete.md): This action submits a background task to delete results. It returns a jobId. Use the jobId to make subsequent calls to track the status of the task. - [List results management tasks](https://techdocs.akamai.com/cloudtest/reference/get-management-tasks.md): Get a list of all tasks. - [Get a results management task](https://techdocs.akamai.com/cloudtest/reference/get-mgmt-task.md): Returns task info for the specified task. - [Stop a results management task](https://techdocs.akamai.com/cloudtest/reference/delete-mgmt-task.md): Attempts to stop a task. Stopping a task doesn't undo any deleted results. It just tells the task to stop as quickly as it can. A status of `STOPPED` means that the task was stopped before it completed. A status of `COMPLETED` means that the task completed before it received the stop command. - [List results](https://techdocs.akamai.com/cloudtest/reference/get-results.md): Get a list of all results that satisfy the query. - [Get a result](https://techdocs.akamai.com/cloudtest/reference/get-result.md): Returns summary info for the specified result. - [Get ramp and marker data](https://techdocs.akamai.com/cloudtest/reference/get-ramp-info-by-resultid.md): Get the Ramp/Marker Information for each result. - [Get aggregate action data](https://techdocs.akamai.com/cloudtest/reference/get-clip-element-metrics.md): Queries action-related metrics (such as HTTP messages or database actions) from a result with grouping/aggregation by location, time in seconds or minutes, network profile, element type, or element name. Use this to get the number of HTTP 404 errors or compute the average response time or determine which assets contained the largest number of bytes. - [Get aggregate collection data](https://techdocs.akamai.com/cloudtest/reference/get-collection-metrics.md): Queries collection related metrics (such as pages or transactions) from a result with grouping/aggregation by location, time in seconds or minutes, network profile, element type, or element name. Use this to determine page load time or transactions per second (tps) or get the 90th percentile for a transaction. - [List load generators](https://techdocs.akamai.com/cloudtest/reference/get-load-generator-info-by-resultid.md): Get the load generators and the location for each result. - [Get virtual user count](https://techdocs.akamai.com/cloudtest/reference/get-virtual-users-metrics.md): Get the number of virtual users for each minute of the test. - [Get a virtual user count time series](https://techdocs.akamai.com/cloudtest/reference/get-virtual-users-metrics-by-interval.md): Get the number of virtual users and peak virtual users within the requested interval (second/minute/hour). - [Get a results database](https://techdocs.akamai.com/cloudtest/reference/get-rsdb.md): Returns a single rsdb. In order to interact with a result database you need the results database ID. See [Get an object](https://techdocs.akamai.com/cloudtest/reference/get-object) for more information. - [Start or stop a results database](https://techdocs.akamai.com/cloudtest/reference/post-action.md): Either `start`, `stop` or `terminate` a results database. The `start` and `terminate` actions are asynchronous and return a 202. A `stop` command is synchronous and returns a 200. See [Asynchronous operations](ref:asynchronous-operations) for details. In order to interact with a result database you need the results database ID. See [Get an object](https://techdocs.akamai.com/cloudtest/reference/get-object) for more information. - [Append seed data](https://techdocs.akamai.com/cloudtest/reference/post-seed-data.md): Appends CSV content to existing seed data. The `.csv` file is sent as a part of the request payload. - [Get seed data](https://techdocs.akamai.com/cloudtest/reference/get-seed-data.md): Returns seed data content as CSV. - [Delete seed data](https://techdocs.akamai.com/cloudtest/reference/delete-seed-data.md): Removes seed data from the repository. - [List servers](https://techdocs.akamai.com/cloudtest/reference/get-servers.md): Get a list of all servers listed in the server list. You need to have server access privileges to access this operation. - [Get a server](https://techdocs.akamai.com/cloudtest/reference/get-server.md): Returns server info for the specified server. You need to have server access privileges to access this operation. - [Initiate tenant sub-data deletion](https://techdocs.akamai.com/cloudtest/reference/post-tenant-subdata-delete.md): This action submits a background task to delete results and monitors under given tenant for passed auth token. It returns a jobId. Use the jobId to make subsequent calls to track the status of the task. - [List tenant management tasks](https://techdocs.akamai.com/cloudtest/reference/get-tenant-mgmt-tasks.md): Get a list of all tasks. - [Get a tenant management task](https://techdocs.akamai.com/cloudtest/reference/get-tenant-mgmt-task.md): Returns a specific task. - [Stop a tenant management task](https://techdocs.akamai.com/cloudtest/reference/delete-tenant-mgmt-task.md): Attempts to stop a task. Stopping a task doesn't undo any deleted results but stops the task as quickly as possible. A status of `STOPPED` means that the task was stopped before it completed. A status of `COMPLETED` means that the task completed before it received the instruction to stop. - [Generate a token](https://techdocs.akamai.com/cloudtest/reference/put-token.md): Authenticates and generates a token. The security token expires after five hours of inactivity. - [Delete a token](https://techdocs.akamai.com/cloudtest/reference/delete-token.md): Delete a token so it can no longer be used for authentication with the API. ## Recipes - [Composition commands](https://techdocs.akamai.com/cloudtest/recipes/composition-commands.md) - [Create an object](https://techdocs.akamai.com/cloudtest/recipes/create-an-object.md) - [Generate a token](https://techdocs.akamai.com/cloudtest/recipes/generate-a-token.md) - [Get a cloud server](https://techdocs.akamai.com/cloudtest/recipes/get-a-cloud-server.md) - [Get a composition](https://techdocs.akamai.com/cloudtest/recipes/get-a-composition.md) - [Get a grid](https://techdocs.akamai.com/cloudtest/recipes/get-a-grid.md) - [Get a results database](https://techdocs.akamai.com/cloudtest/recipes/get-a-results-database.md) - [Get a server](https://techdocs.akamai.com/cloudtest/recipes/get-a-server.md) - [Get a test environment](https://techdocs.akamai.com/cloudtest/recipes/get-a-test-environment.md) - [Get aggregate collection data by multiple groups](https://techdocs.akamai.com/cloudtest/recipes/get-aggregate-collection-data-by-multiple-groups.md) - [Get aggregate collection data](https://techdocs.akamai.com/cloudtest/recipes/get-aggregate-collection-data.md) - [Get an object](https://techdocs.akamai.com/cloudtest/recipes/get-an-object.md) - [List active compositions](https://techdocs.akamai.com/cloudtest/recipes/list-active-compositions.md) - [List cloud servers](https://techdocs.akamai.com/cloudtest/recipes/list-cloud-servers.md) - [List grids](https://techdocs.akamai.com/cloudtest/recipes/list-grids.md) - [List objects](https://techdocs.akamai.com/cloudtest/recipes/list-objects.md) - [List servers](https://techdocs.akamai.com/cloudtest/recipes/list-servers.md) - [Request a delete of test results](https://techdocs.akamai.com/cloudtest/recipes/request-a-delete-of-test-results.md) - [Restart or terminate a cloud server](https://techdocs.akamai.com/cloudtest/recipes/restart-or-terminate-a-cloud-server.md) - [Start or load a composition](https://techdocs.akamai.com/cloudtest/recipes/start-or-load-a-composition.md) - [Start or stop a grid](https://techdocs.akamai.com/cloudtest/recipes/start-or-stop-a-grid.md) - [Start or stop a results database](https://techdocs.akamai.com/cloudtest/recipes/start-or-stop-a-results-database.md) - [Start or stop a test environment](https://techdocs.akamai.com/cloudtest/recipes/start-or-stop-a-test-environment.md) ## Changelog - [June 8, 2026 — Enhancements and fixes](https://techdocs.akamai.com/cloudtest/changelog/june-8-2026-enhancements-and-fixes.md) - [May 8, 2026 — Enhancements and fixes](https://techdocs.akamai.com/cloudtest/changelog/may-8-2026-enhancements-and-bug-fixes.md) - [Mar 31, 2026 — Enhancements and bug fixes](https://techdocs.akamai.com/cloudtest/changelog/mar-31-2026-enhancements-and-bug-fixes.md) - [Feb 19, 2026 — Enhancements and bug fixes](https://techdocs.akamai.com/cloudtest/changelog/feb-19-2026-enhancements-and-bug-fixes.md) - [Dec 26, 2025 — Enhancements and bug fixes](https://techdocs.akamai.com/cloudtest/changelog/dec-26-2025-enhancements-and-bug-fixes.md) # Contract API Documentation > The Contract API provides information about Akamai contracts as well as the products included in those contracts. With this API, you have the option of retrieving product information for a specified time frame by either contract ID or reporting group. ## API Reference - [Contract API](https://techdocs.akamai.com/contract-api/reference/api.md) - [API summary](https://techdocs.akamai.com/contract-api/reference/api-summary.md) - [Get started](https://techdocs.akamai.com/contract-api/reference/api-get-started.md) - [API concepts](https://techdocs.akamai.com/contract-api/reference/concepts.md) - [Rate limits](https://techdocs.akamai.com/contract-api/reference/rate-limits.md) - [API workflow](https://techdocs.akamai.com/contract-api/reference/workflow.md) - [Errors](https://techdocs.akamai.com/contract-api/reference/api-errors.md) - [400](https://techdocs.akamai.com/contract-api/reference/400.md) - [401](https://techdocs.akamai.com/contract-api/reference/401.md) - [403](https://techdocs.akamai.com/contract-api/reference/403.md) - [404](https://techdocs.akamai.com/contract-api/reference/404.md) - [List contracts](https://techdocs.akamai.com/contract-api/reference/get-contract-ids.md): Get the list of contracts that a user has access to. - [List products per contract](https://techdocs.akamai.com/contract-api/reference/get-contract-product-summaries.md): Get the IDs and names of the products associated with a contract for the time frame selected. - [List CP code reporting groups](https://techdocs.akamai.com/contract-api/reference/get-reporting-groups.md): Get the IDs of the Content Provider (CP) reporting groups that you have access to along with their names. To run this operation, your user account needs the CPCode Rep Group role. To add this role, use the [Identity and Access Management application](https://control.akamai.com/admin/?tab=CONFIGURE&type=context). - [List CP code reporting group IDs](https://techdocs.akamai.com/contract-api/reference/get-group-ids.md): Get the IDs of the Content Provider (CP) reporting groups that you have access to. To run this operation, your user account needs the CPCode Rep Group role. To add this role, use the [Identity and Access Management application](https://control.akamai.com/admin/?tab=CONFIGURE&type=context). - [List products per reporting group](https://techdocs.akamai.com/contract-api/reference/get-group-products-summaries.md): Get the IDs and names of the products associated with the reporting group for the time frame selected. To run this operation, your user account needs the CPCode Rep Group role. To add this role, use the [Identity and Access Management application](https://control.akamai.com/admin/?tab=CONFIGURE&type=context). When a request is successful, it may return either a 200 or a 300 response. The API returns a 200 (OK) response when the CP code reporting group is associated with only one contract. You'll receive a `300 Multiple Choices` response when the request returns a list of matching contracts because the CP code reporting group is associated with multiple contracts. To retrieve product information when you receive a 300 response code, make a new GET request to the hyperlinks provided in the response. ## Recipes - [List contracts](https://techdocs.akamai.com/contract-api/recipes/list-contracts.md) - [List CP code reporting group IDs](https://techdocs.akamai.com/contract-api/recipes/list-cp-code-reporting-group-ids.md) - [List CP code reporting groups](https://techdocs.akamai.com/contract-api/recipes/list-cp-code-reporting-groups.md) - [List products per contract](https://techdocs.akamai.com/contract-api/recipes/list-products-per-contract.md) - [List products per reporting group](https://techdocs.akamai.com/contract-api/recipes/list-products-per-reporting-group.md) ## Changelog - [Dec 20, 2023 — Contract API Postman collection available](https://techdocs.akamai.com/contract-api/changelog/dec-20-contract-api-postman-collection-available.md) - [Dec 2, 2021 — New Contract API documentation experience](https://techdocs.akamai.com/contract-api/changelog/dec-2-2021-new-contract-api-documentation-experience.md) # Control Center Documentation > Akamai Control Center is the integrated interface for Akamai’s products, services, and platform. Control Center gives businesses the access, insight, and control they need to deliver the best possible online experiences. Control Center delivers intelligent tools for site and stream management, diagnostics, and collaboration to help businesses thrive in the hyperconnected world. Accessible via web, mobile, and API, Control Center makes it easy for businesses to configure their Akamai services, monitor performance, analyze traffic, and resolve end-user issues in real time, from any device, anywhere. ## Guides - [Welcome to Control Center](https://techdocs.akamai.com/control-ctr/docs/welcome-cc.md) - [Access your services](https://techdocs.akamai.com/control-ctr/docs/access-services.md) - [Status cards](https://techdocs.akamai.com/control-ctr/docs/homepage-status-cards.md) - [Search](https://techdocs.akamai.com/control-ctr/docs/search.md) - [Create](https://techdocs.akamai.com/control-ctr/docs/create.md) ## Changelog - [Jun 30, 2026 — Global menu redesign](https://techdocs.akamai.com/control-ctr/changelog/jun-30-2026-global-menu-redesign.md) - [May 5, 2026 — Homepage redesign](https://techdocs.akamai.com/control-ctr/changelog/may-5-2026-homepage-redesign.md) - [Apr 17, 2026 — Bug fix](https://techdocs.akamai.com/control-ctr/changelog/apr-17-2026-bug-fix.md) - [Jan 21, 2026 — Opportunity Reports decommissioned](https://techdocs.akamai.com/control-ctr/changelog/jan-21-2026-opportunity-reports-decommissioned.md) - [Dec 3, 2025 — Control Center improvements](https://techdocs.akamai.com/control-ctr/changelog/dec-3-2025-control-center-improvements.md) # CP Codes and Reporting Groups Tool Documentation > Akamai's CP Codes and Reporting Groups tool lets you create, edit, view, and delete reporting groups. You can get access to detailed information about CP codes, edit their parameters, and group them for billing purposes. ## Guides - [Welcome to CP Codes and Reporting Groups](https://techdocs.akamai.com/cp-codes/docs/welcome-cp-codes-rpt-grps.md) - [Access and user permissions](https://techdocs.akamai.com/cp-codes/docs/access-and-user-permissions.md) - [Key concepts and terms](https://techdocs.akamai.com/cp-codes/docs/key-concepts-and-terms.md) - [About CP codes](https://techdocs.akamai.com/cp-codes/docs/about-cp-codes.md) - [About reporting groups](https://techdocs.akamai.com/cp-codes/docs/about-rpt-grp.md) - [Create a CP code](https://techdocs.akamai.com/cp-codes/docs/create-cp-code.md) - [Change CP code's name](https://techdocs.akamai.com/cp-codes/docs/change-cp-codes-name.md) - [Edit purge settings for a CP code](https://techdocs.akamai.com/cp-codes/docs/edit-purge-settings-for-a-cp-code.md) - [Override a default time zone](https://techdocs.akamai.com/cp-codes/docs/override-a-default-time-zone.md) - [Create a reporting group](https://techdocs.akamai.com/cp-codes/docs/create-rpt-grp.md) - [Change reporting group's name](https://techdocs.akamai.com/cp-codes/docs/edit-rpt-grp.md) - [Add or remove CP codes](https://techdocs.akamai.com/cp-codes/docs/add-or-remove-cp-codes.md) - [Delete a reporting group](https://techdocs.akamai.com/cp-codes/docs/delete-rpt-grp.md) ## API Reference - [CP Codes and Reporting Groups API](https://techdocs.akamai.com/cp-codes/reference/api.md) - [API summary](https://techdocs.akamai.com/cp-codes/reference/api-summary.md) - [Get started](https://techdocs.akamai.com/cp-codes/reference/api-get-started.md) - [Concepts](https://techdocs.akamai.com/cp-codes/reference/api-concepts.md) - [Rate and resource limiting](https://techdocs.akamai.com/cp-codes/reference/rate-and-resource-limiting.md) - [ID prefixes](https://techdocs.akamai.com/cp-codes/reference/id-prefixes.md) - [Errors](https://techdocs.akamai.com/cp-codes/reference/api-errors.md) - [400](https://techdocs.akamai.com/cp-codes/reference/400.md) - [401](https://techdocs.akamai.com/cp-codes/reference/401.md) - [403](https://techdocs.akamai.com/cp-codes/reference/403.md) - [404](https://techdocs.akamai.com/cp-codes/reference/404.md) - [405](https://techdocs.akamai.com/cp-codes/reference/405.md) - [408](https://techdocs.akamai.com/cp-codes/reference/408.md) - [410](https://techdocs.akamai.com/cp-codes/reference/410.md) - [411](https://techdocs.akamai.com/cp-codes/reference/411.md) - [413](https://techdocs.akamai.com/cp-codes/reference/413.md) - [415](https://techdocs.akamai.com/cp-codes/reference/415.md) - [500](https://techdocs.akamai.com/cp-codes/reference/500.md) - [502](https://techdocs.akamai.com/cp-codes/reference/502.md) - [503](https://techdocs.akamai.com/cp-codes/reference/503.md) - [List CP codes](https://techdocs.akamai.com/cp-codes/reference/get-cpcodes.md): Lists detailed information about CP codes available within your account and contract. - [Get a CP code](https://techdocs.akamai.com/cp-codes/reference/get-cpcode.md): Get detailed information about a specific CP code. The details include the CP code type, name, time zone, as well as the account, contracts, and products it's assigned to. This operation also lists the access control group the CP code belongs to. - [Update a CP code](https://techdocs.akamai.com/cp-codes/reference/put-cpcode.md): Modifies a specific CP code. After running the [GET a CP code](ref:get-cpcode) operation, use the response to build a request body. You can only modify a CP code's name, time zone, and purgeable member. - [Get a water-mark limit](https://techdocs.akamai.com/cp-codes/reference/get-cpcodes-watermark-limits.md): Get a watermark limit for CP codes for the account associated within a specific contract. For more details, see [Rate and resource limiting](ref:rate-and-resource-limiting). - [Create a reporting group](https://techdocs.akamai.com/cp-codes/reference/post-reporting-groups.md): Creates a reporting group. Make sure the reporting group's name is unique within an account. The `location` header in the response provides a relative path to the created reporting group. - [List reporting groups](https://techdocs.akamai.com/cp-codes/reference/get-reporting-groups.md): Lists detailed information about reporting groups available for your account and contract. - [Get a reporting group](https://techdocs.akamai.com/cp-codes/reference/get-reporting-group.md): Get detailed information about a specific reporting group. The details include the reporting group name and the access control group that it belongs to. This operations also lists the contracts and CP codes assigned to the reporting group. - [Update a reporting group](https://techdocs.akamai.com/cp-codes/reference/put-reporting-group.md): Modifies a specific reporting group. You should only modify a reporting group's name and assigned CP codes. - [Delete a reporting group](https://techdocs.akamai.com/cp-codes/reference/delete-reporting-group.md): Deletes a specific reporting group. - [Get a water-mark limit for reporting groups](https://techdocs.akamai.com/cp-codes/reference/get-reporting-groups-watermark-limits.md): Get a watermark limit for CP reporting groups for the account associated within a specific contract. For more details, see [Rate and resource limiting](ref:rate-and-resource-limiting). - [List products within a reporting group](https://techdocs.akamai.com/cp-codes/reference/get-reporting-group-products.md): Lists products and services assigned to a specific reporting group. ## Recipes - [Create a reporting group](https://techdocs.akamai.com/cp-codes/recipes/create-a-reporting-group.md) - [Delete a reporting group](https://techdocs.akamai.com/cp-codes/recipes/delete-a-reporting-group.md) - [Get a CP code](https://techdocs.akamai.com/cp-codes/recipes/get-a-cp-code.md) - [Get a water mark limit for CP codes](https://techdocs.akamai.com/cp-codes/recipes/get-a-water-mark-limit-for-cp-codes.md) - [Get a water mark limit for reporting groups](https://techdocs.akamai.com/cp-codes/recipes/get-a-water-mark-limit-for-reporting-groups.md) - [List CP codes](https://techdocs.akamai.com/cp-codes/recipes/list-cp-codes.md) - [List details of a reporting group](https://techdocs.akamai.com/cp-codes/recipes/list-details-of-a-reporting-group.md) - [List products within a reporting group](https://techdocs.akamai.com/cp-codes/recipes/list-products-within-a-reporting-group.md) - [List reporting groups](https://techdocs.akamai.com/cp-codes/recipes/list-reporting-groups.md) - [Update a CP code](https://techdocs.akamai.com/cp-codes/recipes/update-a-cp-code.md) - [Update a reporting group](https://techdocs.akamai.com/cp-codes/recipes/update-a-reporting-group.md) ## Changelog - [Jul 30, 2021 — New CP Codes and Reporting Tools documentation experience](https://techdocs.akamai.com/cp-codes/changelog/jul-30-2021-new-cp-codes-and-reporting-tools-documentation-experience.md) # DataStream 2 Documentation > Akamai's DataStream provides real-time access to application activity data, including aggregated metrics on complete request-response cycles as well as origin response times. It helps simplify web application monitoring, and includes applications deployed to cloud hosting providers and applications that leverage third-party services. ## Guides - [Welcome to DataStream 2.1](https://techdocs.akamai.com/datastream2/docs/welcome-datastream2.md) - [Key concepts and terms](https://techdocs.akamai.com/datastream2/docs/glossary.md) - [Use cases](https://techdocs.akamai.com/datastream2/docs/datastream-use-cases.md) - [Supported features](https://techdocs.akamai.com/datastream2/docs/features.md) - [Log format](https://techdocs.akamai.com/datastream2/docs/log-format.md) - [Integration types](https://techdocs.akamai.com/datastream2/docs/integration-types.md) - [Security logs (SIEM)](https://techdocs.akamai.com/datastream2/docs/security-logs.md) - [Security data format](https://techdocs.akamai.com/datastream2/docs/security-data-format.md) - [Create a security log stream](https://techdocs.akamai.com/datastream2/docs/create-a-security-log-stream.md) - [Edit a security log stream](https://techdocs.akamai.com/datastream2/docs/edit-a-security-log-stream.md) - [Clone a security log stream](https://techdocs.akamai.com/datastream2/docs/clone-a-security-log-stream.md) - [Security logs (SIEM) FAQ](https://techdocs.akamai.com/datastream2/docs/faq-security-logs.md) - [Quick start](https://techdocs.akamai.com/datastream2/docs/quick-start.md) - [Create a stream](https://techdocs.akamai.com/datastream2/docs/create-stream.md) - [Choose data parameters](https://techdocs.akamai.com/datastream2/docs/choose-data-parameters.md) - [Data set parameters](https://techdocs.akamai.com/datastream2/docs/data-set-parameters.md) - [Reporting metrics and dimensions](https://techdocs.akamai.com/datastream2/docs/reporting.md) - [Stream logs to a destination](https://techdocs.akamai.com/datastream2/docs/stream-logs.md) - [Dynamic variables](https://techdocs.akamai.com/datastream2/docs/dynamic-time-variables.md) - [Stream logs to Amazon S3](https://techdocs.akamai.com/datastream2/docs/stream-amazon-s3.md) - [Stream logs to Azure Storage](https://techdocs.akamai.com/datastream2/docs/stream-azure-storage.md) - [Stream logs to a custom HTTPS endpoint](https://techdocs.akamai.com/datastream2/docs/stream-custom-https.md) - [Stream logs to Datadog](https://techdocs.akamai.com/datastream2/docs/stream-datadog.md) - [Stream logs to Dynatrace](https://techdocs.akamai.com/datastream2/docs/stream-dynatrace.md) - [Stream logs to Elasticsearch](https://techdocs.akamai.com/datastream2/docs/stream-elasticsearch.md) - [Stream logs to Google Cloud Storage](https://techdocs.akamai.com/datastream2/docs/stream-google-cloud.md) - [Stream logs to Loggly](https://techdocs.akamai.com/datastream2/docs/stream-loggly.md) - [Stream logs to New Relic](https://techdocs.akamai.com/datastream2/docs/stream-new-relic.md) - [Stream logs to Oracle Cloud](https://techdocs.akamai.com/datastream2/docs/stream-oracle-cloud.md) - [Stream logs to an S3-compatible destination](https://techdocs.akamai.com/datastream2/docs/stream-s3-compatible.md) - [Stream logs to Splunk](https://techdocs.akamai.com/datastream2/docs/stream-splunk.md) - [Stream logs to Sumo Logic](https://techdocs.akamai.com/datastream2/docs/stream-sumo-logic.md) - [Stream logs to TrafficPeak](https://techdocs.akamai.com/datastream2/docs/stream-trafficpeak.md) - [Review and activate a stream](https://techdocs.akamai.com/datastream2/docs/review-activate-stream.md) - [Enable the DataStream behavior](https://techdocs.akamai.com/datastream2/docs/enable-datastream-behavior.md) - [View and manage versions](https://techdocs.akamai.com/datastream2/docs/manage-versions.md) - [Clone a stream](https://techdocs.akamai.com/datastream2/docs/clone-a-stream.md) - [Edit a stream](https://techdocs.akamai.com/datastream2/docs/edit-stream.md) - [Activate or deactivate a stream](https://techdocs.akamai.com/datastream2/docs/activate-deactivate-stream.md) - [Log custom parameters](https://techdocs.akamai.com/datastream2/docs/log-custom-parameters.md) - [Troubleshooting](https://techdocs.akamai.com/datastream2/docs/troubleshooting.md) - [Set up alerts](https://techdocs.akamai.com/datastream2/docs/set-up-alerts.md) - [FAQ](https://techdocs.akamai.com/datastream2/docs/faq.md) ## API Reference - [DataStream 2 API](https://techdocs.akamai.com/datastream2/reference/api.md) - [API summary](https://techdocs.akamai.com/datastream2/reference/api-summary.md) - [Security logs (SIEM)](https://techdocs.akamai.com/datastream2/reference/security-logs.md) - [Security data format](https://techdocs.akamai.com/datastream2/reference/security-data-format.md) - [Get started](https://techdocs.akamai.com/datastream2/reference/api-get-started.md) - [API concepts](https://techdocs.akamai.com/datastream2/reference/concepts.md) - [API workflow](https://techdocs.akamai.com/datastream2/reference/usage-examples.md) - [Integration types](https://techdocs.akamai.com/datastream2/reference/integrations.md) - [Log types](https://techdocs.akamai.com/datastream2/reference/log-types.md) - [Log format](https://techdocs.akamai.com/datastream2/reference/log-format.md) - [Destinations](https://techdocs.akamai.com/datastream2/reference/destinations.md) - [Patching streams](https://techdocs.akamai.com/datastream2/reference/patching-streams.md) - [Version management](https://techdocs.akamai.com/datastream2/reference/version-management.md) - [Data set parameters](https://techdocs.akamai.com/datastream2/reference/data-set-parameters-api.md) - [Custom log field](https://techdocs.akamai.com/datastream2/reference/custom-log-field.md) - [Rate limiting](https://techdocs.akamai.com/datastream2/reference/rate-limiting.md) - [Errors](https://techdocs.akamai.com/datastream2/reference/api-errors.md) - [400](https://techdocs.akamai.com/datastream2/reference/400.md) - [403](https://techdocs.akamai.com/datastream2/reference/403.md) - [404](https://techdocs.akamai.com/datastream2/reference/404.md) - [410](https://techdocs.akamai.com/datastream2/reference/410.md) - [415](https://techdocs.akamai.com/datastream2/reference/415.md) - [429](https://techdocs.akamai.com/datastream2/reference/429.md) - [500](https://techdocs.akamai.com/datastream2/reference/500.md) - [504](https://techdocs.akamai.com/datastream2/reference/504.md) - [List Application Security configurations](https://techdocs.akamai.com/datastream2/reference/get-configs-appsec.md): Returns all Application Security configurations on your contract. Run this operation to get the `id` and `name` values you need as `appSecId` and `appSecName` to run [Create a security log stream](ref:post-stream-appsec) or [Edit a security log stream](ref:put-stream-appsec). Run [List groups](ref:get-groups) to get the `groupId` and `contractId`. - [Create a security log stream](https://techdocs.akamai.com/datastream2/reference/post-stream-appsec.md): Creates a stream configuration for [Security Information and Event Management](https://techdocs.akamai.com/datastream2/reference/security-logs) (SIEM) events. Logging security events requires enabling data collection for [SIEM integrations](https://techdocs.akamai.com/siem-integration/docs/akamai-siem-integration-for-splunk-and-cef-syslog#step-1-turn-on-siem-integration) in your security configuration. For details on this log type, see [Security logs](ref:log-types#security-logs). Run [List security configurations](ref:get-configs-appsec) to get the security configuration `id` and `name` you can use as the `appSecId` and `appSecName`. You can `activate` the stream when making the request, or later. Note that only active streams collect and send logs to their destinations. See [Activate a stream](ref:post-stream-activate). - [Edit a security log stream](https://techdocs.akamai.com/datastream2/reference/put-stream-appsec.md): Updates the latest version of a [Security Information and Event Management](https://techdocs.akamai.com/datastream2/reference/security-logs) (SIEM) events stream for Application Security. Each time you edit a stream, its version number increments. Note that only active streams collect and send logs to their destinations. You need to set the `activate` parameter to `true` while patching active streams, and optionally for inactive streams if you want to activate them upon request. See [Version management](ref:version-management) and [Activate a stream](ref:post-stream-activate). - [Patch a security log stream](https://techdocs.akamai.com/datastream2/reference/patch-stream-appsec.md): Updates selected details of an existing [Security Information and Event Management](https://techdocs.akamai.com/datastream2/reference/security-logs) (SIEM) events stream. Running this operation using [JSON Patch](http://jsonpatch.com) syntax creates a stream version that replaces the current one. Currently you can patch a stream using only the `replace` operation. When updating configuration objects such as `destination` or `deliveryConfiguration`, pass a complete object to avoid overwriting current details with default values for omitted fields such as `tags`, `uploadFilePrefix`, and `uploadFileSuffix`. Note that only active streams collect and send logs to their destinations. You need to set the `activate` parameter to `true` while patching active streams, and optionally for inactive streams if you want to activate them upon request. See [Patching streams](ref:patching-streams) for details. - [Delete a security log stream](https://techdocs.akamai.com/datastream2/reference/delete-stream-appsec.md): Deletes a deactivated [Security Information and Event Management](https://techdocs.akamai.com/datastream2/reference/security-logs) (SIEM) events stream. Deleting a stream means you can't activate this stream again, and you stop receiving logs for the properties this stream monitors. Before deleting any stream, you need to deactivate it first. See [Deactivate a stream](ref:post-stream-activate). - [List security logs streams](https://techdocs.akamai.com/datastream2/reference/get-streams-appsec.md): Returns the [Security Information and Event Management](https://techdocs.akamai.com/datastream2/reference/security-logs) (SIEM) stream configurations' latest versions for all groups on your account. Use the `groupId` query parameter to view the latest versions of all configurations in a specific group, or up to five property names as the `objectName` parameter to get streams for specific properties. - [List CDN properties by group](https://techdocs.akamai.com/datastream2/reference/get-properties-cdn.md): Returns delivery properties (also referred to as _objects_) active on the production and staging network within a specific group. Run this operation to get the `objectId` values you need to provide as `propertyId` to [Create a delivery stream](ref:post-stream-cdn) or [Edit a delivery stream](ref:put-stream-cdn). - [List Edge DNS zones by contract](https://techdocs.akamai.com/datastream2/reference/get-properties-edns.md): Returns Edge DNS zones on your contract. Run this operation to get the `zoneName` values you need to [Create an Edge DNS stream](ref:post-stream-edns) or [Edit an Edge DNS stream](ref:put-stream-edns). - [List GTM properties by contract](https://techdocs.akamai.com/datastream2/reference/get-properties-gtm.md): Returns Global Traffic Management (GTM) domain properties on your contract. Run this operation to get the `propertyName` values you need to [Create a GTM stream](ref:post-stream-gtm) or [Edit a GTM stream](ref:put-stream-gtm). - [Create a delivery stream](https://techdocs.akamai.com/datastream2/reference/post-stream-cdn.md): Creates a stream configuration for delivery products. You can choose delivery properties to monitor in the stream, data set fields to collect in logs, and a destination to send these log files to. Get the `streamId` value from the response to [Get a stream](ref:get-stream). Apart from the log and delivery frequency configurations, you can decide to `activate` the stream when making the request, or later. Note that only active streams collect and send logs to their destinations. See [Activate a stream](ref:post-stream-activate). - [Edit a delivery (CDN) stream](https://techdocs.akamai.com/datastream2/reference/put-stream-cdn.md): Updates the latest version of a delivery stream. Each time you edit a stream, its version number increments. Note that only active streams collect and send logs to their destinations. You need to set the `activate` parameter to `true` while patching active streams, and optionally for inactive streams if you want to activate them upon request. See [Version management](ref:version-management) and [Activate a stream](ref:post-stream-activate). - [Create an EdgeWorkers stream](https://techdocs.akamai.com/datastream2/reference/post-stream-ew.md): Creates a stream configuration for [EdgeWorkers](https://techdocs.akamai.com/edgeworkers/docs/welcome-to-edgeworkers). Get the `streamId` value from the response to [Get an EdgeWorkers stream](ref:get-stream). Apart from the log and delivery frequency configurations, you can decide to `activate` the stream when making the request, or later. Note that only active streams collect and send logs to their destinations. See [Activate a stream](ref:post-stream-activate). - [Create an Edge DNS stream](https://techdocs.akamai.com/datastream2/reference/post-stream-edns.md): Creates a stream configuration for [Edge DNS](https://techdocs.akamai.com/edge-dns/docs/welcome-edge-dns). You can choose the zones to monitor in the stream, data set fields to collect in logs, and a destination to send these log files to. Get the `streamId` value from the response to [Get a stream](ref:get-stream). Apart from the log and delivery frequency configurations, you can decide to `activate` the stream when making the request, or later. Note that only active streams collect and send logs to their destinations. See [Activate a stream](ref:post-stream-activate). - [Edit an Edge DNS stream](https://techdocs.akamai.com/datastream2/reference/put-stream-edns.md): Updates the latest version of an [Edge DNS](https://techdocs.akamai.com/edge-dns/docs/welcome-edge-dns) stream. Each time you edit a stream, its version number increments. Note that only active streams collect and send logs to their destinations. You need to set the `activate` parameter to `true` while patching active streams, and optionally for inactive streams if you want to activate them upon request. See [Version management](ref:version-management) and [Activate a stream](ref:post-stream-activate). - [Edit an EdgeWorkers stream](https://techdocs.akamai.com/datastream2/reference/put-stream-ew.md): Updates the latest version of an [EdgeWorkers](https://techdocs.akamai.com/edgeworkers/docs/welcome-to-edgeworkers) stream. Each time you edit a stream, its version number increments. Note that only active streams collect and send logs to their destinations. You need to set the `activate` parameter to `true` while patching active streams, and optionally for inactive streams if you want to activate them upon request. See [Version management](ref:version-management) and [Activate a stream](ref:post-stream-activate). - [Create a GTM stream](https://techdocs.akamai.com/datastream2/reference/post-stream-gtm.md): Creates a stream configuration for [Global Traffic Management](https://techdocs.akamai.com/gtm/docs/welcome-to-global-traffic-management). You can choose the properties to monitor in the stream, data set fields to collect in logs, and a destination to send these log files to. Get the `streamId` value from the response to [Get a stream](ref:get-stream). Apart from the log and delivery frequency configurations, you can decide to `activate` the stream when making the request, or later. Note that only active streams collect and send logs to their destinations. See [Activate a stream](ref:post-stream-activate). - [Edit a GTM stream](https://techdocs.akamai.com/datastream2/reference/put-stream-gtm.md): Updates the latest version of a [Global Traffic Management](https://techdocs.akamai.com/gtm/docs/welcome-to-global-traffic-management) stream. Each time you edit a stream, its version number increments. Note that only active streams collect and send logs to their destinations. You need to set the `activate` parameter to `true` while patching active streams, and optionally for inactive streams if you want to activate them upon request. See [Version management](ref:version-management) and [Activate a stream](ref:post-stream-activate). - [Patch a stream](https://techdocs.akamai.com/datastream2/reference/patch-stream.md): Updates selected details of an existing stream. Running this operation using [JSON Patch](http://jsonpatch.com) syntax creates a stream version that replaces the current one. Currently you can patch a stream using only the `REPLACE` operation. When updating configuration objects such as `destination` or `deliveryConfiguration`, pass a complete object to avoid overwriting current details with default values for omitted fields such as `tags`, `uploadFilePrefix`, and `uploadFileSuffix`. Note that only active streams collect and send logs to their destinations. You need to set the `activate` parameter to `true` while patching active streams, and optionally for inactive streams if you want to activate them upon request. See [Patching streams](ref:patching-streams) for details. - [List streams](https://techdocs.akamai.com/datastream2/reference/get-streams.md): Returns the stream configurations' latest versions for all groups on your account within a specific `logType`. Use up to five property names as the `objectName` parameter to get streams for specific properties. - [View upload metrics](https://techdocs.akamai.com/datastream2/reference/get-streams-metrics.md): Returns aggregated metrics for log file uploads, including success or failure upload counts, upload latency, and the volume of data uploaded in the stream. Set the `start` and `end` dates to get metrics from a specific time range, and `aggregationInterval` to group data by time intervals. - [Get a stream](https://techdocs.akamai.com/datastream2/reference/get-stream.md): Returns details about any version of a stream, including the monitored properties or zones, logged data set fields, and log delivery destination. If you omit the `version` query parameter, this operation returns the stream's last version. - [Delete a stream](https://techdocs.akamai.com/datastream2/reference/delete-stream.md): Deletes a deactivated stream. Deleting a stream means you can't activate this stream again, and you stop receiving logs for the properties this stream monitors. Before deleting any stream, you need to deactivate it first. See [Deactivate a stream](ref:post-stream-activate). - [List data set fields](https://techdocs.akamai.com/datastream2/reference/get-dataset-fields.md): Lists available data set fields you can choose to monitor in your logs in a stream configuration. Use the `logType` and `productId` parameters to get data sets available for a specific log type or product. Requests without `productId` return data set fields available for all products, omitting product-specific fields. Run this operation to get the `datasetFieldId` and `datasetFieldName` values you need to create or edit a stream. - [List groups](https://techdocs.akamai.com/datastream2/reference/get-groups.md): Returns access groups with contracts on your account. You can later use the `groupId` and `contractId` values to create and view streams or list properties by group. Set the `contractId` query parameter to get groups for a specific contract. - [Activate a stream](https://techdocs.akamai.com/datastream2/reference/post-stream-activate.md): Activates the latest version of a stream. Activating a stream takes approximately an hour. Once a stream is active, and the [DataStream behavior](https://techdocs.akamai.com/property-mgr/docs/datastream-beh) is enabled in Property Manager, it replaces and deactivates the previous version, then starts collecting data and sending log files to a destination. If you want to stop receiving the logs, you can [Deactivate a stream](ref:post-stream-activate) at any time. Run [List streams](ref:get-streams) to check your stream's activation status. - [View activation history](https://techdocs.akamai.com/datastream2/reference/get-stream-activation-history.md): Returns the details of activation status changes for all versions of a given stream within a specific `logType`. - [Deactivate a stream](https://techdocs.akamai.com/datastream2/reference/post-stream-deactivate.md): Deactivates the latest version of a stream. Deactivating a stream means that you stop receiving logs for properties this stream monitors, and changes status to `DEACTIVATED` in approximately an hour. If you want to start receiving log files again, you can activate the stream at any time using the [Activate a stream](ref:post-stream-activate) operation. - [View history](https://techdocs.akamai.com/datastream2/reference/get-stream-history.md): Returns details about all versions of a given stream. It helps you track changes between the stream's versions, including monitored properties, logged data set fields, and log delivery destinations. Optionally, set both the `startVersion` and `endVersion` parameters to get details on all stream versions for a given range. For example, setting `startVersion` to `1` and `endVersion` to `3` returns details on the stream's `1`, `2`, and `3` versions. ## Recipes - [Activate a stream (v2)](https://techdocs.akamai.com/datastream2/recipes/activate-a-stream-v2.md) - [Create a stream for a custom HTTPS endpoint (v2)](https://techdocs.akamai.com/datastream2/recipes/create-a-stream-for-a-custom-https-endpoint-v2.md) - [Create a stream for Amazon S3 (v2)](https://techdocs.akamai.com/datastream2/recipes/create-a-stream-for-amazon-s3-v2.md) - [Create a stream for an S3-compatible destination (v2)](https://techdocs.akamai.com/datastream2/recipes/create-a-stream-for-an-s3-compatible-destination-v2.md) - [Create a stream for Azure (v2)](https://techdocs.akamai.com/datastream2/recipes/create-a-stream-for-azure-v2.md) - [Create a stream for Datadog (v2)](https://techdocs.akamai.com/datastream2/recipes/create-a-stream-for-datadog-v2.md) - [Create a stream for Elasticsearch (v2)](https://techdocs.akamai.com/datastream2/recipes/create-a-stream-for-elasticsearch-v2.md) - [Create a stream for Google Cloud Storage (v2)](https://techdocs.akamai.com/datastream2/recipes/create-a-stream-for-google-cloud-storage-v2.md) - [Create a stream for Loggly (v2)](https://techdocs.akamai.com/datastream2/recipes/create-a-stream-for-loggly-v2.md) - [Create a stream for New Relic (v2)](https://techdocs.akamai.com/datastream2/recipes/create-a-stream-for-new-relic-v2.md) - [Create a stream for Oracle Cloud (v2)](https://techdocs.akamai.com/datastream2/recipes/create-a-stream-for-oracle-cloud-v2.md) - [Create a stream for Splunk (v2)](https://techdocs.akamai.com/datastream2/recipes/create-a-stream-for-splunk-v2.md) - [Create a stream for Sumo Logic (v2)](https://techdocs.akamai.com/datastream2/recipes/create-a-stream-for-sumo-logic-v2.md) - [Deactivate a stream (v2)](https://techdocs.akamai.com/datastream2/recipes/deactivate-a-stream-v2.md) - [Delete a stream (v2)](https://techdocs.akamai.com/datastream2/recipes/delete-a-stream-v2.md) - [Edit a stream (v2)](https://techdocs.akamai.com/datastream2/recipes/edit-a-stream-v2.md) - [Get a stream (v2)](https://techdocs.akamai.com/datastream2/recipes/get-a-stream-v2.md) - [List properties by group (v2)](https://techdocs.akamai.com/datastream2/recipes/list-properties-by-group-v2.md) - [Patch a stream](https://techdocs.akamai.com/datastream2/recipes/patch-a-stream.md) - [View stream history (v2)](https://techdocs.akamai.com/datastream2/recipes/view-stream-history-v2.md) ## Changelog - [Jul 8, 2026 — Flexible property selection for streams](https://techdocs.akamai.com/datastream2/changelog/jul-8-2026-flexible-property-selection.md) - [Jun 8, 2026 — Security Logs (SIEM) support in DataStream](https://techdocs.akamai.com/datastream2/changelog/jun-8-2026-security-logs-siem-support-in-datastream.md) - [Jun 1, 2026 — DataStream 2 API v2 Decommissioning](https://techdocs.akamai.com/datastream2/changelog/jun-1-2026-datastream-2-api-v2-decommissioning.md) - [Apr 29, 2026 – Property Manager decoupling support](https://techdocs.akamai.com/datastream2/changelog/apr-29-2026-property-manager-decoupling-support.md) - [Mar 26, 2026 – Latency Profiles support](https://techdocs.akamai.com/datastream2/changelog/mar-26-2026-latency-profiles-and-high-completeness-log-support.md) # Deliver your first site Documentation > To help speed up the onboarding process, this document provides a specific workflow you can follow to get your site up and running on the Akamai network. ## Guides - [Get started](https://techdocs.akamai.com/onboard/docs/get-started.md) - [1. Set up identity and access](https://techdocs.akamai.com/onboard/docs/set-up-identity-and-access-ui.md) - [2. Set up a secure certificate](https://techdocs.akamai.com/onboard/docs/set-up-a-secure-cert-ui.md) - [3. Set up your origin server](https://techdocs.akamai.com/onboard/docs/set-up-your-origin-ui.md) - [4. Set up your property](https://techdocs.akamai.com/onboard/docs/set-up-your-property-ui.md) - [5. Test and go live](https://techdocs.akamai.com/onboard/docs/test-and-go-live-ui.md) - [1. Set up identity and access](https://techdocs.akamai.com/onboard/docs/set-up-identity-and-access-api.md) - [2. Set up a secure certificate](https://techdocs.akamai.com/onboard/docs/set-up-a-secure-cert-api.md) - [3. Set up your origin server](https://techdocs.akamai.com/onboard/docs/set-up-your-origin-api.md) - [4. Set up your property](https://techdocs.akamai.com/onboard/docs/set-up-your-property-api.md) - [Manage with a code editor](https://techdocs.akamai.com/onboard/docs/manage-with-a-code-editor.md) - [5. Test and go live](https://techdocs.akamai.com/onboard/docs/test-and-go-live-api.md) - [Add features](https://techdocs.akamai.com/onboard/docs/you-can-add-more.md) - [Run reports](https://techdocs.akamai.com/onboard/docs/you-can-run-reports.md) ## Recipes - [CPS: Create a certificate enrollment](https://techdocs.akamai.com/onboard/recipes/cps-create-a-certificate-enrollment.md) - [CPS: Get a change](https://techdocs.akamai.com/onboard/recipes/cps-get-a-change.md) - [CPS: List enrollments](https://techdocs.akamai.com/onboard/recipes/cps-list-enrollments.md) - [CPS: Update your certificate to go live](https://techdocs.akamai.com/onboard/recipes/cps-update-your-certificate-to-go-live.md) - [IDM: Clone an Identity Management user](https://techdocs.akamai.com/onboard/recipes/idm-clone-an-identity-management-user.md) - [IDM: Create a new user](https://techdocs.akamai.com/onboard/recipes/idm-create-a-new-user.md) - [IDM: Create a role](https://techdocs.akamai.com/onboard/recipes/idm-create-a-role.md) - [IDM: List grantable roles](https://techdocs.akamai.com/onboard/recipes/idm-list-grantable-roles.md) - [IDM: List groups](https://techdocs.akamai.com/onboard/recipes/idm-list-groups.md) - [IDM: List Identity Management users](https://techdocs.akamai.com/onboard/recipes/idm-list-identity-management-users.md) - [NS: Create a storage group](https://techdocs.akamai.com/onboard/recipes/ns-create-a-storage-group.md) - [NS: Create an upload account](https://techdocs.akamai.com/onboard/recipes/ns-create-an-upload-account.md) - [NS: List storage groups](https://techdocs.akamai.com/onboard/recipes/ns-list-storage-groups.md) - [PAPI: Activate on production](https://techdocs.akamai.com/onboard/recipes/papi-activate-on-production.md) - [PAPI: Activate on staging](https://techdocs.akamai.com/onboard/recipes/papi-activate-on-staging.md) - [PAPI: Add your edge hostname to your Ion property](https://techdocs.akamai.com/onboard/recipes/papi-add-your-edge-hostname-to-your-ion-property.md) - [PAPI: Check edge hostname status](https://techdocs.akamai.com/onboard/recipes/papi-check-edge-hostname-status.md) - [PAPI: Create a Standard TLS edge hostname](https://techdocs.akamai.com/onboard/recipes/papi-create-a-standard-tls-edge-hostname.md) - [PAPI: Create an Ion property](https://techdocs.akamai.com/onboard/recipes/papi-create-an-ion-property.md) - [PAPI: Get your Ion property's rule tree](https://techdocs.akamai.com/onboard/recipes/papi-get-your-ion-propertys-rule-tree.md) - [PAPI: List contracts](https://techdocs.akamai.com/onboard/recipes/papi-list-contracts.md) - [PAPI: List groups](https://techdocs.akamai.com/onboard/recipes/papi-list-groups.md) - [PAPI: List properties](https://techdocs.akamai.com/onboard/recipes/papi-list-properties.md) - [PAPI: List your edge hostnames](https://techdocs.akamai.com/onboard/recipes/papi-list-your-edge-hostnames.md) - [PAPI: Update your Ion property's rule tree](https://techdocs.akamai.com/onboard/recipes/papi-update-your-ion-propertys-rule-tree.md) - [Reporting: List reports](https://techdocs.akamai.com/onboard/recipes/reporting-list-reports.md) - [Reporting: Traffic by time and response](https://techdocs.akamai.com/onboard/recipes/reporting-traffic-by-time-and-response.md) # Domain Ownership Manager Documentation > Domain Ownership Manager (DOM) is a service that prevents unauthorized use of hostnames on the Akamai network and strengthens security. Use the UI or API to prove domain ownership before you onboard new domains and hostnames to Akamai. ## Guides - [Welcome to Domain Ownership Manager](https://techdocs.akamai.com/domain-validation/docs/welcome.md) - [Key concepts and terms](https://techdocs.akamai.com/domain-validation/docs/terminology.md) - [Validation overview](https://techdocs.akamai.com/domain-validation/docs/validation-overview.md) - [Validate a domain using DNS CNAME record](https://techdocs.akamai.com/domain-validation/docs/validate-a-domain-using-dns-cname-record.md) - [Validate a domain using DNS TXT record](https://techdocs.akamai.com/domain-validation/docs/validate-a-domain-using-dns-txt-record.md) - [Validate a domain using HTTP file](https://techdocs.akamai.com/domain-validation/docs/validate-a-domain-using-http-server.md) - [Validate a domain using HTTP redirect](https://techdocs.akamai.com/domain-validation/docs/validate-a-domain-using-http-redirect.md) - [Instantly validate a domain](https://techdocs.akamai.com/domain-validation/docs/instantly-validate-a-domain.md) - [View domain details](https://techdocs.akamai.com/domain-validation/docs/view-domain-details.md) - [Invalidate a domain](https://techdocs.akamai.com/domain-validation/docs/invalidate-domain.md) - [Delete a domain validation](https://techdocs.akamai.com/domain-validation/docs/delete-domain-validation.md) - [Frequently asked questions](https://techdocs.akamai.com/domain-validation/docs/faq.md) - [Domain status stuck in the Validation in Progress state](https://techdocs.akamai.com/domain-validation/docs/domain-status-stuck.md) ## API Reference - [Domain Ownership Manager API](https://techdocs.akamai.com/domain-validation/reference/api.md) - [API summary](https://techdocs.akamai.com/domain-validation/reference/api-summary.md) - [Get started](https://techdocs.akamai.com/domain-validation/reference/get-started.md) - [API workflow](https://techdocs.akamai.com/domain-validation/reference/api-workflow.md) - [Rate limiting](https://techdocs.akamai.com/domain-validation/reference/rate-limiting.md) - [Errors](https://techdocs.akamai.com/domain-validation/reference/errors.md) - [400](https://techdocs.akamai.com/domain-validation/reference/400.md) - [401](https://techdocs.akamai.com/domain-validation/reference/401.md) - [403](https://techdocs.akamai.com/domain-validation/reference/403.md) - [404](https://techdocs.akamai.com/domain-validation/reference/404.md) - [405](https://techdocs.akamai.com/domain-validation/reference/405.md) - [409](https://techdocs.akamai.com/domain-validation/reference/409.md) - [500](https://techdocs.akamai.com/domain-validation/reference/500.md) - [List domains](https://techdocs.akamai.com/domain-validation/reference/get-domains.md): Returns the list of available domains. By default, the results are paginated. You can disable pagination to retrieve all domains at once, but if the number of domains exceeds the allowed limit, the request returns a 409 Conflict error. In that case, use the pagination parameters to retrieve the full set of results. - [Add domains](https://techdocs.akamai.com/domain-validation/reference/post-domains.md): Add domains to validate. - [Get a domain](https://techdocs.akamai.com/domain-validation/reference/get-domain.md): Returns a domain. - [Validate pending domains](https://techdocs.akamai.com/domain-validation/reference/post-validate-domains.md): Immediately validates the domains using the DNS CNAME, DNS TXT, and HTTP methods. Use this operation when you've already updated your DNS or HTTP server and want to skip the standard queue to start the validation now. - [Invalidate a domain](https://techdocs.akamai.com/domain-validation/reference/post-invalidate-domain.md): Invalidates the specified domain. When you invalidate a domain, Akamai doesn't recognize you as its owner. The domain is then automatically deleted as part of a cleanup procedure. You can also [delete it manually](ref:delete-domain). - [Invalidate domains](https://techdocs.akamai.com/domain-validation/reference/post-invalidate-domains.md): Invalidates the specified domains. When you invalidate a domain, Akamai doesn't recognize you as its owner. The domain is then automatically deleted as part of a cleanup procedure. You can also [delete it manually](ref:delete-domain). - [Delete a domain](https://techdocs.akamai.com/domain-validation/reference/delete-domain.md): Deletes a domain validation. You can only delete a domain that is invalidated or has an expired token. When you delete a domain, Akamai doesn't recognize you as its owner. To revalidate a deleted domain, submit it for validation again. - [Batch-delete domains](https://techdocs.akamai.com/domain-validation/reference/delete-domains.md): Deletes the specified domains. You can only delete domains that are invalidated or have expired tokens. When you delete domains, Akamai doesn't recognize you as their owner. To revalidate deleted domains, submit them for validation again. - [Search for domains](https://techdocs.akamai.com/domain-validation/reference/post-search-domains.md): Returns the status of specified domains. For any nonexistent domains, the API returns the closest matching domain status. ## Recipes - [Add domains to validate](https://techdocs.akamai.com/domain-validation/recipes/add-domains-to-validate.md) - [Delete a domain](https://techdocs.akamai.com/domain-validation/recipes/delete-a-domain.md) - [Get a domain](https://techdocs.akamai.com/domain-validation/recipes/get-a-domain.md) - [Invalidate a domain](https://techdocs.akamai.com/domain-validation/recipes/invalidate-a-domain.md) - [Invalidate domains](https://techdocs.akamai.com/domain-validation/recipes/invalidate-domains.md) - [List domains](https://techdocs.akamai.com/domain-validation/recipes/list-domains.md) - [Search for domains](https://techdocs.akamai.com/domain-validation/recipes/search-for-domains.md) - [Validate pending domains](https://techdocs.akamai.com/domain-validation/recipes/validate-pending-domains.md) ## Changelog - [Apr 28, 2026 – Domain Ownership Manager in General Availability](https://techdocs.akamai.com/domain-validation/changelog/apr-28-2026-domain-ownership-manager-in-general-availability.md) - [Nov 14, 2025 – (Beta) New API for Domain Ownership Manager](https://techdocs.akamai.com/domain-validation/changelog/nov-14-2025-beta-new-api-for-domain-ownership-manager.md) - [Oct 30, 2025 – New ownership validation process for domains](https://techdocs.akamai.com/domain-validation/changelog/oct-30-2025-domain-ownership-manager.md) # Download Delivery Documentation > A reliable, high performance file-based content delivery solution, Download Delivery delivers large (>100 MB) file-based content over the Internet. Built on the globally distributed Akamai Platform for superior capacity, scalability, availability, and performance, it provides clear, comprehensive metrics and optional tools that can monitor and manage the entire download process across your customer base. Download Delivery ensures a predictable, high-quality download experience while helping you address your online distribution goals. ## Guides - [Welcome to Download Delivery](https://techdocs.akamai.com/download-delivery/docs/welcome-download-delivery.md) - [Delivery concepts and terms](https://techdocs.akamai.com/download-delivery/docs/delivery-concepts-and-terms.md) - [Get your unique information](https://techdocs.akamai.com/download-delivery/docs/get-environmental-information.md) - [Understand the request flow](https://techdocs.akamai.com/download-delivery/docs/understand-the-request-flow.md) - [Prepare your environment](https://techdocs.akamai.com/download-delivery/docs/prepare-your-environment.md) - [Create a Download Delivery property](https://techdocs.akamai.com/download-delivery/docs/create-new-prop.md) - [Define property hostnames](https://techdocs.akamai.com/download-delivery/docs/define-prop-hn.md) - [Define property variables (optional)](https://techdocs.akamai.com/download-delivery/docs/define-property-variables-optional.md) - [Define property configuration settings](https://techdocs.akamai.com/download-delivery/docs/define-property-configuration-settings.md) - [Default optimizations](https://techdocs.akamai.com/download-delivery/docs/best-practices-and-use-case-based-provisioning.md) - [Origin Characteristics & Download Delivery](https://techdocs.akamai.com/download-delivery/docs/origin-characteristics-and-dd.md) - [Content Characteristics & Download Delivery](https://techdocs.akamai.com/download-delivery/docs/content-charac-dd.md) - [Client Characteristics & Download Delivery](https://techdocs.akamai.com/download-delivery/docs/client-characteristics-and-dd.md) - [Origin Server & Download Delivery](https://techdocs.akamai.com/download-delivery/docs/origin-server-and-dd.md) - [Content Provider Code & Download Delivery](https://techdocs.akamai.com/download-delivery/docs/content-provider-code-and-dd.md) - [Cache Key Query Parameters & Download Delivery](https://techdocs.akamai.com/download-delivery/docs/cache-key-query-parameters-and-dd.md) - [Quick Retry & Download Delivery](https://techdocs.akamai.com/download-delivery/docs/quick-retry-and-dd.md) - [Recommended behaviors in the Default Rule](https://techdocs.akamai.com/download-delivery/docs/rcmd-behs-default-rule.md) - [Optional behaviors in the Default Rule](https://techdocs.akamai.com/download-delivery/docs/optal-behs-default-rule.md) - [Add optional rules](https://techdocs.akamai.com/download-delivery/docs/add-optional-rules.md) - [Finalize your Download Delivery property](https://techdocs.akamai.com/download-delivery/docs/finalize-your-dd-property.md) - [Test your Download Delivery property](https://techdocs.akamai.com/download-delivery/docs/test-your-dd-property.md) - [Go live with Download Delivery](https://techdocs.akamai.com/download-delivery/docs/go-live.md) - [Auth Token 2.0 Verification](https://techdocs.akamai.com/download-delivery/docs/add-auth-token-20-verification.md) - [Bit Rate Limiting](https://techdocs.akamai.com/download-delivery/docs/add-bit-rate-limiting.md) - [Breadcrumbs](https://techdocs.akamai.com/download-delivery/docs/add-breadcrumbs.md) - [Client Hints](https://techdocs.akamai.com/download-delivery/docs/client-hints.md) - [Cloud Access Manager](https://techdocs.akamai.com/download-delivery/docs/add-cloud-access-manager.md) - [Cloud Wrapper](https://techdocs.akamai.com/download-delivery/docs/cloud-wrapper.md) - [Early Data (0-RTT)](https://techdocs.akamai.com/download-delivery/docs/early-data-0-rtt.md) - [Edge IP Binding](https://techdocs.akamai.com/download-delivery/docs/add-edge-ip-binding.md) - [EdgeWorkers](https://techdocs.akamai.com/download-delivery/docs/add-edgeworkers.md) - [Enhanced Debug](https://techdocs.akamai.com/download-delivery/docs/enhanced-debug.md) - [Enhanced Proxy Detection](https://techdocs.akamai.com/download-delivery/docs/add-enhanced-proxy-detection.md) - [HTTP to HTTPS Upgrade](https://techdocs.akamai.com/download-delivery/docs/upgrade-a-request-from-http-to-https.md) - [Mixed Mode](https://techdocs.akamai.com/download-delivery/docs/use-mixed-mode-dd.md) - [Separate origins and different auth methods](https://techdocs.akamai.com/download-delivery/docs/separate-origins-and-different-auth-methods.md) - [Different Client and Content Characteristics](https://techdocs.akamai.com/download-delivery/docs/different-client-and-content-characteristics.md) - [Known limitations with MMC](https://techdocs.akamai.com/download-delivery/docs/known-limitations-with-mmc.md) - [Origin IP access control list](https://techdocs.akamai.com/download-delivery/docs/origin-ip-access-control-list-dd.md) - [Protect connections with mTLS](https://techdocs.akamai.com/download-delivery/docs/protect-connections-with-mtls.md) - [Protocol Downgrade](https://techdocs.akamai.com/download-delivery/docs/add-protocol-downgrade.md) - [The legacy Protocol Downgrade behavior](https://techdocs.akamai.com/download-delivery/docs/the-legacy-protocol-downgrade-behavior.md) - [No PII content](https://techdocs.akamai.com/download-delivery/docs/no-pii-content.md) - [Add the Protocol Downgrade behavior](https://techdocs.akamai.com/download-delivery/docs/add-the-protocol-downgrade-behavior.md) - [Quick Retry](https://techdocs.akamai.com/download-delivery/docs/add-quick-retry.md) - [Mapping Solution – Media Delivery Type](https://techdocs.akamai.com/download-delivery/docs/add-use-case-based-edge-mapping.md) - [Edit edge hostnames to use Media Delivery Type](https://techdocs.akamai.com/download-delivery/docs/edit-edge-hostnames-to-use-ucem.md) - [Set up Media Delivery Type](https://techdocs.akamai.com/download-delivery/docs/set-up-ucem.md) - [Mismatch issues and UCEM](https://techdocs.akamai.com/download-delivery/docs/mismatch-issues-and-ucem.md) - [The Vary HTTP header](https://techdocs.akamai.com/download-delivery/docs/include-the-vary-http-header.md) - [View reports for Download Delivery](https://techdocs.akamai.com/download-delivery/docs/view-reports.md) - [Download Delivery service-level agreement](https://techdocs.akamai.com/download-delivery/docs/service-level-agreement-for-dd.md) ## API Reference - [APIs and Download Delivery](https://techdocs.akamai.com/download-delivery/reference/apis-and-download-delivery.md) ## Changelog - [Oct 8, 2024 – Update to Origin IP ACL support](https://techdocs.akamai.com/download-delivery/changelog/oct-8-2024-update-to-origin-ip-acl-support.md) - [Sep 30, 2024 – New Enhanced Debug and Early Data behaviors](https://techdocs.akamai.com/download-delivery/changelog/sep-30-2024-new-enhanced-debug-and-early-data-behaviors.md) - [Jan 11, 2024 – Client Hints support](https://techdocs.akamai.com/download-delivery/changelog/jan-11-2024-client-hints-support.md) - [Dec 18, 2023 — Support for mTLS](https://techdocs.akamai.com/download-delivery/changelog/dec-18-2023-support-for-mtls.md) - [Nov 7, 2023 – Origin IP ACL](https://techdocs.akamai.com/download-delivery/changelog/nov-7-2023-origin-ip-acl.md) # Edge Diagnostics Documentation > Edge Diagnostics allows you to diagnose your server, DNS, and network problems from Akamai servers around the world. ## Guides - [Welcome to Edge Diagnostics](https://techdocs.akamai.com/edge-diagnostics/docs/welcome-edge-diagnostics.md) - [How to access Edge Diagnostics](https://techdocs.akamai.com/edge-diagnostics/docs/access-edge-diagnostics.md) - [Choose a tool or problem scenario](https://techdocs.akamai.com/edge-diagnostics/docs/tools-scenarios-descriptions.md) - [See it in action](https://techdocs.akamai.com/edge-diagnostics/docs/see-it-in-action.md) - [Translate Error String](https://techdocs.akamai.com/edge-diagnostics/docs/translate-error-string.md) - [User Diagnostic Data](https://techdocs.akamai.com/edge-diagnostics/docs/user-diagnostic-data.md) - [Verify and Locate IP](https://techdocs.akamai.com/edge-diagnostics/docs/verify-locate-ip.md) - [View Logs (GREP)](https://techdocs.akamai.com/edge-diagnostics/docs/view-logs-grep.md) - [Get Error Statistics](https://techdocs.akamai.com/edge-diagnostics/docs/get-error-statistics.md) - [Metadata Tracer](https://techdocs.akamai.com/edge-diagnostics/docs/metadata-tracer-mdt.md) - [ESI Debugger](https://techdocs.akamai.com/edge-diagnostics/docs/esi-debugger.md) - [Request Content (CURL)](https://techdocs.akamai.com/edge-diagnostics/docs/request-content-curl.md) - [Test Network Connectivity (MTR)](https://techdocs.akamai.com/edge-diagnostics/docs/network-connectivity-mtr.md) - [Get Domain Details (DIG)](https://techdocs.akamai.com/edge-diagnostics/docs/domain-details-dig.md) - [Map Diff](https://techdocs.akamai.com/edge-diagnostics/docs/map-diff.md) - [Data Center Diagnostics](https://techdocs.akamai.com/edge-diagnostics/docs/data-center-diagnostics.md) - [IP Diagnostics](https://techdocs.akamai.com/edge-diagnostics/docs/ip-diagnostics.md) - [URL Health Check](https://techdocs.akamai.com/edge-diagnostics/docs/url-health-check.md) - [Connectivity Problems](https://techdocs.akamai.com/edge-diagnostics/docs/connectivity-problems.md) - [Content Problems](https://techdocs.akamai.com/edge-diagnostics/docs/content-problems.md) - [ARL syntax](https://techdocs.akamai.com/edge-diagnostics/docs/arl-syntax.md) - [Error codes](https://techdocs.akamai.com/edge-diagnostics/docs/error-codes.md) - [Object status](https://techdocs.akamai.com/edge-diagnostics/docs/object-status.md) - [Pragma headers](https://techdocs.akamai.com/edge-diagnostics/docs/pragma-headers.md) - [ESI syntax message](https://techdocs.akamai.com/edge-diagnostics/docs/esi-syntax-message.md) - [Evaluation messages](https://techdocs.akamai.com/edge-diagnostics/docs/evaluation-messages.md) ## API Reference - [Edge Diagnostics API](https://techdocs.akamai.com/edge-diagnostics/reference/edge-diagnostics-api-1.md) - [API summary](https://techdocs.akamai.com/edge-diagnostics/reference/api-summary.md) - [Get started](https://techdocs.akamai.com/edge-diagnostics/reference/get-started.md) - [Rate limiting](https://techdocs.akamai.com/edge-diagnostics/reference/rate-limiting.md) - [Asynchronous processes](https://techdocs.akamai.com/edge-diagnostics/reference/asynchronous-processes.md) - [Site Shield requests](https://techdocs.akamai.com/edge-diagnostics/reference/site-shield-requests.md) - [Sensitive request headers](https://techdocs.akamai.com/edge-diagnostics/reference/sensitive-headers.md) - [Errors](https://techdocs.akamai.com/edge-diagnostics/reference/api-errors.md) - [400](https://techdocs.akamai.com/edge-diagnostics/reference/400.md) - [401](https://techdocs.akamai.com/edge-diagnostics/reference/401.md) - [403](https://techdocs.akamai.com/edge-diagnostics/reference/403.md) - [404](https://techdocs.akamai.com/edge-diagnostics/reference/404.md) - [405](https://techdocs.akamai.com/edge-diagnostics/reference/405.md) - [429](https://techdocs.akamai.com/edge-diagnostics/reference/429.md) - [500](https://techdocs.akamai.com/edge-diagnostics/reference/500.md) - [List available edge server locations](https://techdocs.akamai.com/edge-diagnostics/reference/get-edge-locations.md): Lists active edge server locations you can use to run [Request content with cURL](ref:post-curl), [Get domain details with dig](ref:post-dig), [Test network connectivity with MTR](ref:post-mtr), [Run the URL health check](ref:post-url-health-check), [Run the connectivity problems scenario](ref:post-connectivity-problems), and [Run the content problems scenario](ref:post-content-problems) operations. To get a subset of edge servers supporting metadata tracer, run the [List available edge server locations for metadata tracing](ref:get-mdt-locations) operation. - [Verify an IP](https://techdocs.akamai.com/edge-diagnostics/reference/post-verify-edge-ip.md): Verifies if an IP belongs to an edge server. For IPs verified positively, you can continue gathering diagnostic data with [Request content with cURL](ref:post-curl), [Get domain details with dig](ref:post-dig), or [Test network connectivity with MTR](ref:post-mtr) operations. You can enter up to 10 IPs. - [Locate an IP network](https://techdocs.akamai.com/edge-diagnostics/reference/post-locate-ip.md): Returns geolocation data of an IP's network. You can enter up to 10 IPs. - [Verify and locate an IP](https://techdocs.akamai.com/edge-diagnostics/reference/post-verify-locate-ip.md): Verifies if an IP belongs to an edge server and gets the geolocation data of its network. For IPs verified positively, you can continue gathering diagnostic data with [Request content with cURL](ref:post-curl), [Get domain details with dig](ref:post-dig), or [Test network connectivity with MTR](ref:post-mtr) operations. - [List GTM properties](https://techdocs.akamai.com/edge-diagnostics/reference/get-gtm-properties.md): Lists GTM properties you have access to. You can use the returned `hostname` values to run [Test network connectivity with MTR](ref:post-mtr) and [Get domain details with dig](ref:post-dig) operations for a GTM hostname. Note, that the [Test network connectivity with MTR](ref:post-mtr) operation requires also hostname's test and target IP values, that you can get with the [List test and target IPs for a GTM hostname](ref:get-gtm-property-domain-gtm-property-ips) operation. - [List test and target IPs for a GTM hostname](https://techdocs.akamai.com/edge-diagnostics/reference/get-gtm-property-domain-gtm-property-ips.md): Lists test and target IPs for a GTM property. You can use the returned data to run the [Test network connectivity with MTR](ref:post-mtr) operation for a GTM hostname. To get the data necessary for this request, run the [List GTM properties](ref:get-gtm-properties) operation first. - [List IP acceleration hostnames](https://techdocs.akamai.com/edge-diagnostics/reference/get-ipa-hostnames.md): Lists IP acceleration (IPA) hostnames you have access to and can [generate a diagnostic link](ref:post-user-diagnostic-data-groups) to collect diagnostic data. - [Translate error string](https://techdocs.akamai.com/edge-diagnostics/reference/post-error-translator.md): Launches an [asynchronous](ref:asynchronous-processes) request to fetch summary and logs for an error with a specific reference code. You can also translate any Global Request Number (GRN) generated by the Property Manager's Global Request Number behavior. You can get the error logs from the last 6 or 24 hours depending on the server and traffic conditions. For operations in progress, the returned object contains `retryAfter`, `requestId`, and `link`. In this case, wait for the duration of the `retryAfter` interval, then either use the `requestId` to run the [Get a translate error string response](ref:get-error-translator-request) operation, or simply GET the `link`. - [Get a translate error string response](https://techdocs.akamai.com/edge-diagnostics/reference/get-error-translator-request.md): Returns the status of the [asynchronous](ref:asynchronous-processes) [Translate error string](ref:post-error-translator) request. For operations with the `SUCCESS` status, the response includes details about the error. For operations in progress, the returned object contains `retryAfter`, `requestId`, and `link`. In this case, wait for the duration of the `retryAfter` interval, then run this operation again or simply GET the `link`. - [Generate a diagnostic link](https://techdocs.akamai.com/edge-diagnostics/reference/post-user-diagnostic-data-groups.md): Generates a diagnostic link for you to share with end users of a particular URL or IP acceleration hostname experiencing similar issues. After an end user clicks the link, the tool gathers necessary diagnostic data and asks the end user to submit it. Once submitted, you can check the collected data with the [Get diagnostic data of a group](ref:get-user-diagnostic-data-group-records) operation. Each link is valid for 7 days of 50 submissions. To get the list of IP acceleration hostname you can collect diagnostic data for, run the [List IP acceleration hostnames](ref:get-ipa-hostnames) operation first. - [List end user groups](https://techdocs.akamai.com/edge-diagnostics/reference/get-user-diagnostic-data-groups.md): Lists groups created for collecting diagnostic data and their details. A group stores diagnostic data of end users of a particular domain experiencing similar issues submitted with the specific diagnostic link. To create the diagnostic link, run the [Generate a diagnostic link](ref:post-user-diagnostic-data-groups) operation. To check the data collected for a group, store the returned `groupId` value and use it to run the [Get diagnostic data of a group](ref:get-user-diagnostic-data-group-records) operation. - [Get diagnostic data for an end user group](https://techdocs.akamai.com/edge-diagnostics/reference/get-user-diagnostic-data-group-records.md): Returns collected diagnostic data for a specific group. You can also request additional cURL, DIG, and MTR data. To get the `groupId` value, run the [List groups](ref:get-user-diagnostic-data-groups) operation first. - [Get error statistics](https://techdocs.akamai.com/edge-diagnostics/reference/post-estats.md): Returns HTTP status codes distribution statistics from delivering a URL or CP code based on the nine-second traffic sample from the last two minutes. You can filter the results by `delivery` and `errorType`. The `delivery` is the delivery type of your resource, either `ENHANCED_TLS` or `STANDARD_TLS`. The `STANDARD_TLS` value returns data for the HTTP traffic with Standard TLS hostname, whereas `ENHANCED_TLS` for the HTTPS traffic with Enhanced TLS hostname. Without this filter, Edge Diagnostics checks on its own the type of delivery used by your resource and returns data for it. If your resource uses both delivery types, then Edge Diagnostics returns data for the type which got all data collected faster. If you choose the delivery type not used by your resource, then the results are empty. If you want to add this filter, you can run the [Get an edge hostname](https://techdocs.akamai.com/edge-hostnames/reference/get-edgehostnameid) operation in [Edge Hostnames API](https://techdocs.akamai.com/edge-hostnames/reference/api) to confirm the delivery type of your resource. It's the `securityType` value. The `errorType` filter is for the traffic's direction. The `EDGE_ERRORS` value returns data for the traffic between a customer and an edge server and `ORIGIN_ERRORS` between the edge server and the origin. Without this filter, Edge Diagnostics returns data for both directions. - [Launch a metadata tracing request](https://techdocs.akamai.com/edge-diagnostics/reference/post-mdt.md): Launches an [asynchronous](ref:asynchronous-processes) request to trace metadata for a URL configured in Property Manager. The metadata tracing works for the current property version active either on staging or production. To run the operation for a location, run the [List available locations for metadata tracing](ref:get-mdt-locations) operation first to get available values. If you don't provide a location ID or an edge server IP, then Edge Diagnostics runs the operation using a random location. The operation doesn't support requests for zone apex mapping (ZAM) and hostnames lacking a CNAME on the staging environment. - [List available edge server locations for metadata tracing](https://techdocs.akamai.com/edge-diagnostics/reference/get-mdt-locations.md): Lists active locations you can use to run the [Launch a metadata tracing request](ref:post-mdt) operation together with information about supported HTTP methods. The operation responds with a subset of edge servers returned by the [List available edge server locations](ref:get-edge-locations) operation. - [Check a metadata tracing request status](https://techdocs.akamai.com/edge-diagnostics/reference/get-mdt-request.md): Returns the status of the [asynchronous](ref:asynchronous-processes) [Launch a Metadata Tracer request](ref:post-mdt) operation. For operations with the `SUCCESS` status, the response includes the metadata details. For requests with the `Accept: text/html` request header, results are in static HTML format. To learn more about the results, check [How to read the results](ref:mdt-results). - [How to read the results](https://techdocs.akamai.com/edge-diagnostics/reference/mdt-results.md) - [Get an ESI debugging report](https://techdocs.akamai.com/edge-diagnostics/reference/post-debug.md): This operation provides a debugging report on the ESI code of your source page and all pages that the source page references. - [Request content with cURL](https://techdocs.akamai.com/edge-diagnostics/reference/post-curl.md): Requests content using the `curl` command to provide the raw HTML for a URL, including request headers. You can run this operation for a specific location, an edge server IP, or a Site Shield map. If you want to get the data for a location, you need to run the [List available edge server locations](ref:get-edge-locations) operation first to get `edgeLocationId`. And if you want to run this operation for an IP, you may need to [verify an IP](ref:post-verify-edge-ip) to check if it belongs to an edge server. If you provide neither a location nor an edge server IP, then Edge Diagnostics runs the operation using a random edge server IP. - [Launch a GREP request](https://techdocs.akamai.com/edge-diagnostics/reference/post-grep.md): Launches an [asynchronous](ref:asynchronous-processes) request to fetch logs for an edge server IP address using the `grep` command. To verify if an IP belongs to an edge server, run the [Verify an IP](ref:post-verify-edge-ip) operation first. If you known the exact values to filter the logs by and you want to get the data directly, run the synchronous [Get specific logs](ref:get-grep) operation. - [Get specific logs](https://techdocs.akamai.com/edge-diagnostics/reference/get-grep.md): Using the `grep` command, returns logs that match the query parameters. This operation gets the data directly. If you don't have detailed information about the logs or you want to avoid latency, run the [Launch a GREP request](ref:post-grep) operation. If you provide request parameters for which Edge Diagnostics doesn't find logs, you get the validation error. - [Check a GREP request status](https://techdocs.akamai.com/edge-diagnostics/reference/get-grep-request.md): Returns the status of the [asynchronous](ref:asynchronous-processes) [Launch a GREP request](ref:post-grep) request. Operations with the `SUCCESS` status include also the `grep` logs. - [Translate an Akamaized URL](https://techdocs.akamai.com/edge-diagnostics/reference/post-translated-url.md): Provides basic information about a specific hostname or domain name, such as typecode, origin server, CP code, serial number, and TTL. A URL becomes an [Akamaized URL (ARL)](doc:arl-syntax) once it's on an edge server. - [Get domain details with dig](https://techdocs.akamai.com/edge-diagnostics/reference/post-dig.md): Uses the `dig` command to provide DNS details for the location of an edge server, a hostname or a domain name, or a GTM hostname. The results may help you diagnose issues with domain name resolutions. You can run this operation either for a specific location or an edge IP. If you want to get the data for a location, you need to run the [List available edge server locations](ref:get-edge-locations) operation first to get `edgeLocationId`. To run this operation for an IP, you may need to [verify an IP](ref:post-verify-edge-ip), if it belongs to an edge server. And to run this operation for a GTM hostname, you need to run the [List GTM properties](ref:get-gtm-properties) operation first. If you don't provide neither a location ID nor an edge server IP, then Edge Diagnostics runs the operation using a random edge server IP. - [Test network connectivity with MTR](https://techdocs.akamai.com/edge-diagnostics/reference/post-mtr.md): Uses MTR to provide information about packet loss and latency between an edge server IP, location, or Site Shield map and a remote destination. To run this operation for an IP, you may need to [verify an IP](ref:post-verify-edge-ip) if it belongs to an edge server. To run this operation for a GTM hostname, run [List GTM properties](ref:get-gtm-properties) and [List test and target IPs for a GTM hostname](ref:get-gtm-property-domain-gtm-property-ips) operations first to get the test and target IPs for the hostname. - [Run the URL health check](https://techdocs.akamai.com/edge-diagnostics/reference/post-url-health-check.md): Launches an [asynchronous](ref:asynchronous-processes) request to simultaneously run [Launch a GREP request](ref:post-grep), [Get domain details with dig](ref:post-dig), [Request content with cURL](ref:post-curl), [Test network connectivity with MTR](ref:post-mtr) and [Translate an Akamaized URL](ref:post-translated-url) operations for a URL. Successful operations return fetched GREP, dig, cURL, and MTR data and [Akamaized URL (ARL)](doc:arl-syntax) details. - [Get a URL health check response](https://techdocs.akamai.com/edge-diagnostics/reference/get-url-health-check-requests.md): Returns the status of the [asynchronous](ref:asynchronous-processes) [Run the URL health check](ref:post-url-health-check) request. Operations with the `SUCCESS` status include also fetched GREP, dig, cURL, and MTR data. - [Run the Connectivity problems scenario](https://techdocs.akamai.com/edge-diagnostics/reference/post-connectivity-problems.md): Launches an [asynchronous](ref:asynchronous-processes) request to simultaneously run [Launch a GREP request](ref:post-grep), [Request content with cURL](ref:post-curl), and [Test network connectivity with MTR](ref:post-mtr) operations for a URL. It may help you diagnose issues with slow download and high response time. Successful operations return fetched GREP, cURL, and MTR data. - [Get the Connectivity problems scenario response](https://techdocs.akamai.com/edge-diagnostics/reference/get-connectivity-problems-request.md): Returns the status of the [asynchronous](ref:asynchronous-processes) [Run the connectivity problems scenario](ref:post-connectivity-problems) request. Operations with the `SUCCESS` status include also fetched GREP, cURL, and MTR data. - [Run the Content problems scenario](https://techdocs.akamai.com/edge-diagnostics/reference/post-content-problems.md): Launches an [asynchronous](ref:asynchronous-processes) request to simultaneously run [Launch a GREP request](ref:post-grep) and [Request content with cURL](ref:post-curl) operations for a URL. It may help you diagnose issues with slow download and high response time. Successful operations return fetched GREP and cURL data. - [Get the Content problems scenario response](https://techdocs.akamai.com/edge-diagnostics/reference/get-content-problems.md): Returns the status of the [asynchronous](ref:asynchronous-processes) [Run the content problems scenario](ref:post-content-problems) request. Operations with the `SUCCESS` status include fetched GREP and cURL data. ## Recipes - [Check a GREP request status](https://techdocs.akamai.com/edge-diagnostics/recipes/check-a-grep-request-status.md) - [Check a metadata tracing request status](https://techdocs.akamai.com/edge-diagnostics/recipes/check-a-metadata-tracing-request-status.md) - [Get a translate error string response](https://techdocs.akamai.com/edge-diagnostics/recipes/get-a-translate-error-string-response.md) - [Get a URL health check response](https://techdocs.akamai.com/edge-diagnostics/recipes/get-a-url-health-check-response.md) - [Get diagnostic data of a group](https://techdocs.akamai.com/edge-diagnostics/recipes/get-diagnostic-data-of-a-group.md) - [Get the Connectivity problems scenario response](https://techdocs.akamai.com/edge-diagnostics/recipes/get-the-connectivity-problems-scenario-response.md) - [Get the Content problems scenario response](https://techdocs.akamai.com/edge-diagnostics/recipes/get-the-content-problems-scenario-response.md) - [Launch a GREP request](https://techdocs.akamai.com/edge-diagnostics/recipes/launch-a-grep-request.md) - [Launch a metadata tracing request](https://techdocs.akamai.com/edge-diagnostics/recipes/launch-a-metadata-tracing-request.md) - [List Test IP and Target IP for a GTM hostname](https://techdocs.akamai.com/edge-diagnostics/recipes/list-test-ip-and-target-ip-for-a-gtm-hostname.md) - [Run dig for a GTM hostname](https://techdocs.akamai.com/edge-diagnostics/recipes/run-dig-for-a-gtm-hostname.md) - [Run dig for a hostname and IP](https://techdocs.akamai.com/edge-diagnostics/recipes/run-dig-for-a-hostname-and-ip.md) - [Run dig for a hostname and location](https://techdocs.akamai.com/edge-diagnostics/recipes/run-dig-for-a-hostname-and-location.md) - [Run MTR between a GTM hostname and a destination](https://techdocs.akamai.com/edge-diagnostics/recipes/run-mtr-between-a-gtm-hostname-and-a-destination.md) - [Run MTR between an IP or hostname and a destination](https://techdocs.akamai.com/edge-diagnostics/recipes/run-mtr-between-an-ip-or-hostname-and-a-destination.md) - [Run MTR for a Site Shield hostname](https://techdocs.akamai.com/edge-diagnostics/recipes/run-mtr-for-a-site-shield-hostname.md) - [Run the Connectivity problems scenario](https://techdocs.akamai.com/edge-diagnostics/recipes/run-the-connectivity-problems-scenario.md) - [Run the Content problems scenario](https://techdocs.akamai.com/edge-diagnostics/recipes/run-the-content-problems-scenario.md) - [Run the URL health check](https://techdocs.akamai.com/edge-diagnostics/recipes/run-the-url-health-check.md) ## Changelog - [Mar 11, 2024 — Reference error page improvement](https://techdocs.akamai.com/edge-diagnostics/changelog/mar-11-2024.md) - [June 21, 2023 — Edge Diagnostics improvements](https://techdocs.akamai.com/edge-diagnostics/changelog/june-21-2023.md) - [Apr 5, 2023 — Postman collection available](https://techdocs.akamai.com/edge-diagnostics/changelog/apr-5-2023-postman-collection-available.md) - [Mar 28, 2023 - Edge Diagnostics improvements](https://techdocs.akamai.com/edge-diagnostics/changelog/mar-28-2023.md) - [Mar 2, 2023 — Edge Diagnostics improvements](https://techdocs.akamai.com/edge-diagnostics/changelog/mar-2-2023.md) # Edge DNS Documentation > Edge DNS is a cloud-based DNS solution that provides 24/7 DNS availability, improves DNS responsiveness, and has the resilience to defend against the largest DDoS attacks. Built on a globally distributed Anycast network, it can be implemented as a primary or secondary DNS service, replacing or augmenting existing DNS infrastructure as needed. ## Guides - [Welcome to Edge DNS](https://techdocs.akamai.com/edge-dns/docs/welcome-edge-dns.md) - [Architecture](https://techdocs.akamai.com/edge-dns/docs/architecture.md) - [Features](https://techdocs.akamai.com/edge-dns/docs/features.md) - [Configure primary zones](https://techdocs.akamai.com/edge-dns/docs/config-prim-zones.md) - [Configure secondary zones](https://techdocs.akamai.com/edge-dns/docs/config-second-zones.md) - [Enable cross-account subzone delegation](https://techdocs.akamai.com/edge-dns/docs/enable-subzone-deleg.md) - [Enable outbound zone transfers](https://techdocs.akamai.com/edge-dns/docs/outbound-zone-transfers.md) - [Enable DNSSEC](https://techdocs.akamai.com/edge-dns/docs/enable-dnssec.md) - [Set up multi-signer DNSSEC](https://techdocs.akamai.com/edge-dns/docs/multisigner-dnssec.md) - [Configure alias zones](https://techdocs.akamai.com/edge-dns/docs/config-alias-zones.md) - [Go live](https://techdocs.akamai.com/edge-dns/docs/go-live.md) - [Manage active zones](https://techdocs.akamai.com/edge-dns/docs/mng-active-zones.md) - [Multiprovider DNS support](https://techdocs.akamai.com/edge-dns/docs/multiprovider-dns.md) - [Deprovision](https://techdocs.akamai.com/edge-dns/docs/deprovision.md) - [Set up infrastructure security analytics](https://techdocs.akamai.com/edge-dns/docs/security-analytics.md) - [NXDOMAIN spike detection](https://techdocs.akamai.com/edge-dns/docs/nxdomain-spike-detection.md) - [Dangling CNAME detection](https://techdocs.akamai.com/edge-dns/docs/dangling-cname-detection.md) - [DNS hijacking detection](https://techdocs.akamai.com/edge-dns/docs/dns-hijacking-detection.md) - [Related domain detection](https://techdocs.akamai.com/edge-dns/docs/related-domain-detection.md) - [Manage the related domains report](https://techdocs.akamai.com/edge-dns/docs/manage-related-domains.md) - [Manage infrastructure security analytics](https://techdocs.akamai.com/edge-dns/docs/manage-security-analytics.md) - [Create a destination in Infrastructure Security Analytics](https://techdocs.akamai.com/edge-dns/docs/create-destination-sa.md) - [Monitor and report on service, traffic, and threats](https://techdocs.akamai.com/edge-dns/docs/monitor-rpt-svc-traffic-threats.md) - [Monitor and report on events](https://techdocs.akamai.com/edge-dns/docs/monitor-rpt-events.md) - [Monitor performance with alerts](https://techdocs.akamai.com/edge-dns/docs/monitor-perf-alerts.md) - [Schedule log delivery](https://techdocs.akamai.com/edge-dns/docs/enable-log-delivery.md) - [Send Edge DNS data to your SIEM solution](https://techdocs.akamai.com/edge-dns/docs/edns-siem-config.md) - [Send Prolexic data to your SIEM solution](https://techdocs.akamai.com/edge-dns/docs/prolexic-data-to-siem.md) - [Overview of Shield NS53](https://techdocs.akamai.com/edge-dns/docs/shield-dns-proxy.md) - [Firewall and allowlist requirements](https://techdocs.akamai.com/edge-dns/docs/shield-firewall-req.md) - [Shield NS53 analytics](https://techdocs.akamai.com/edge-dns/docs/shield-ns53-analytics.md) - [Set up and go live with Shield NS53](https://techdocs.akamai.com/edge-dns/docs/shield-setup.md) - [Manage a shield configuration](https://techdocs.akamai.com/edge-dns/docs/manage-shield.md) - [Troubleshoot zone transfer status issues](https://techdocs.akamai.com/edge-dns/docs/trbl-zone-xfer-stat.md) - [Troubleshoot provisioning and active services](https://techdocs.akamai.com/edge-dns/docs/troubleshoot-provisioning-and-active-services.md) - [Known issues in EdgeDNS](https://techdocs.akamai.com/edge-dns/docs/edns-common-issues.md) ## API Reference - [Edge DNS API v2](https://techdocs.akamai.com/edge-dns/reference/edge-dns-api.md) - [API summary](https://techdocs.akamai.com/edge-dns/reference/api-summary.md) - [Get started](https://techdocs.akamai.com/edge-dns/reference/get-started.md) - [Use pagination](https://techdocs.akamai.com/edge-dns/reference/use-pagination.md) - [Group IDs and access level](https://techdocs.akamai.com/edge-dns/reference/group-ids-access-level.md) - [Supported DNS resource record types](https://techdocs.akamai.com/edge-dns/reference/supported-dns-resource-record-types.md) - [Use change lists](https://techdocs.akamai.com/edge-dns/reference/use-change-lists.md) - [Example: Create a new primary zone](https://techdocs.akamai.com/edge-dns/reference/example-create-new-primary-zone.md) - [Zone create failure states](https://techdocs.akamai.com/edge-dns/reference/zone-create-failure-vals.md) - [Subzone grants](https://techdocs.akamai.com/edge-dns/reference/subzone-grants.md) - [Definitions of the activationState](https://techdocs.akamai.com/edge-dns/reference/activation-state-definitions.md) - [Edge DNS API Troubleshooting](https://techdocs.akamai.com/edge-dns/reference/edns-api-troubleshooting.md) - [Errors](https://techdocs.akamai.com/edge-dns/reference/api-errors.md) - [304](https://techdocs.akamai.com/edge-dns/reference/304.md) - [400](https://techdocs.akamai.com/edge-dns/reference/400.md): Bad request - [401](https://techdocs.akamai.com/edge-dns/reference/401.md): API authentication error - [403](https://techdocs.akamai.com/edge-dns/reference/403.md): Forbidden - [404](https://techdocs.akamai.com/edge-dns/reference/404.md): Not found - [405](https://techdocs.akamai.com/edge-dns/reference/405.md): Method Not Allowed - [409](https://techdocs.akamai.com/edge-dns/reference/409.md): Conflict - [415](https://techdocs.akamai.com/edge-dns/reference/415.md): Unsupported Media Type - [503](https://techdocs.akamai.com/edge-dns/reference/503.md): Service Unavailable - [Get a zone's DNSSEC status](https://techdocs.akamai.com/edge-dns/reference/post-zones-dns-sec-status.md): Returns the current DNSSEC status for one or more zones. - [Get a zone's DNSSEC DNSKEY records](https://techdocs.akamai.com/edge-dns/reference/get-zone-dnskeys.md): Get the current DNSSEC DNSKEY records for a zone. - [Get matching DS record key tags](https://techdocs.akamai.com/edge-dns/reference/get-zones-zone-matching-ds-record-key-tags.md): Returns the key tag values from DS records in the parent zone that match the zone's current DNSKEY records. Use this to verify DS delegation is correctly configured. - [Get secondary zones transfer status](https://techdocs.akamai.com/edge-dns/reference/post-zones-zone-transfer-status.md): Returns the results of the most recent zone transfer attempts for one or more zones. When you configure a `SECONDARY` zone, several Akamai name servers known as zone transfer agents perform zone transfer requests to fetch the record data from the zone's configured master name servers. The data returned by this operation describes the results of those zone transfers. - [Get a zone's contract](https://techdocs.akamai.com/edge-dns/reference/get-zone-contract.md): Show data about the contract to which this zone belongs. - [Create a zone](https://techdocs.akamai.com/edge-dns/reference/post-zone.md): Creates a new zone. Carefully review the documentation for which fields are relevant to the type of zone you're creating. - [List zones](https://techdocs.akamai.com/edge-dns/reference/get-zones.md): All zones that the current user has access to manage. The response is [paginated](ref:use-pagination). - [Bulk edit secondary zones](https://techdocs.akamai.com/edge-dns/reference/post-zones-edit-secondary-zones.md): Updates settings for one or more secondary zones in a single operation. - [Get zone propagation status](https://techdocs.akamai.com/edge-dns/reference/post-zones-propagation-status.md): Returns the current propagation status for one or more zones, showing what percentage of name servers have received the latest zone data. - [Get a zone's settings](https://techdocs.akamai.com/edge-dns/reference/get-zone.md): Retrieves the metadata for this zone. Does not include record sets. - [Update a zone's settings](https://techdocs.akamai.com/edge-dns/reference/put-zone.md): Modifies a zone's settings. You can't change the zone `type` with this operation. - [Get a zone's aliases](https://techdocs.akamai.com/edge-dns/reference/get-zone-aliases.md): Show all zones that alias to this zone. - [Schedule an immediate zone transfer](https://techdocs.akamai.com/edge-dns/reference/put-zones-zone-schedule-immediate-transfer.md): Schedules an immediate zone transfer for the specified secondary zone, bypassing any pending transfer delays. - [List a zone's versions](https://techdocs.akamai.com/edge-dns/reference/get-zone-versions.md): Shows the settings for current and prior versions of this Zone, in reverse chronological order of modification. Many versions in this list may look very similar because a new version is created every time the zone's settings or record sets are changed. This operation is [paginated](ref:use-pagination). - [Show zone version differences](https://techdocs.akamai.com/edge-dns/reference/get-zone-versions-diff.md): Displays the difference between any two versions of a zone, as specified in the query parameters. - [Get a zone version](https://techdocs.akamai.com/edge-dns/reference/get-zone-versions-uuid.md): Returns an image of the Zone from a previous version. Shows only zone settings, not record sets. - [Get a version's record sets](https://techdocs.akamai.com/edge-dns/reference/get-zone-versions-recordsets.md): Lists all record sets for this zone. It works only for `PRIMARY` and `SECONDARY` zones. This operation [paginates](ref:use-pagination). - [Reactivate a version](https://techdocs.akamai.com/edge-dns/reference/post-zones-zone-versions-uuid-recordsets-activate.md): Creates and activates a new version of the zone by copying the record sets from a prior version of this zone and reapplying them to the current version. The new version has a new, auto-incremented SOA serial number, and the zone's modification data is set to the current time and user. All other zone settings remain the same as the current version. - [Get a version's master zone file](https://techdocs.akamai.com/edge-dns/reference/get-zones-zone-versions-uuid-zone-file.md): Downloads the record sets from a prior zone version in [master zone file](ref:get-zone-versions-uuid) format. This applies to primary and secondary zones. - [Create a change list](https://techdocs.akamai.com/edge-dns/reference/post-changelists.md): Creates a new change list based on the most recent version of a zone. No POST body is needed, since the object is read-only. - [List user's change lists](https://techdocs.akamai.com/edge-dns/reference/get-changelists.md): Retrieves the change lists that you created. Otherwise, displays both stale change lists and change lists for zones you can no longer access. - [Search for change lists](https://techdocs.akamai.com/edge-dns/reference/post-changelists-search.md): Retrieves the change lists that you've created for the specified zone names. If the input list is empty, the response doesn't return any change lists. Note that it's possible to own a change list on a zone that you're no longer allowed to access. - [Get a change list](https://techdocs.akamai.com/edge-dns/reference/get-changelists-zone.md): Describes a change list, showing its base zone version, last modified time, and current change tag. - [Delete a change list](https://techdocs.akamai.com/edge-dns/reference/delete-changelists-zone.md): Removes an unneeded change list. - [Show changes](https://techdocs.akamai.com/edge-dns/reference/get-changelists-zone-diff.md): Show [differences](ref:get-zone-versions-diff) between this change list and its base version. - [List record set names for a change list](https://techdocs.akamai.com/edge-dns/reference/get-changelists-zone-names.md): Retrieves existing record names on this zone, based on the change list. If a record is deleted in the change list, it doesn't appear on the records returned. If no record sets exist within the change list, this operation returns an empty list. - [Submit a change list](https://techdocs.akamai.com/edge-dns/reference/post-changelists-zone-submit.md): Applies all of the changes in this change list to the current zone. This operation fails if the change list has become stale. - [Get change list settings](https://techdocs.akamai.com/edge-dns/reference/get-changelists-zone-settings.md): Retrieves the zone's settings based on the selected change list. Zone settings include metadata about the zone, but not the record sets. The data returned reflects the zone setting changes included in the change list. This call works even if the change list is stale. - [Update change list settings](https://techdocs.akamai.com/edge-dns/reference/put-changelists-zone-settings.md): Updates the change list with new Zone settings. The entire Zone object is needed no matter how many fields you're updating. - [List record set types for name and change list](https://techdocs.akamai.com/edge-dns/reference/get-changelists-zone-names-name-types.md): Retrieves existing record set types for a given name based on the selected change list. The record sets returned reflect the changes added to the change list. Records deleted in this change list don't appear. If the name doesn't exist within the change list, returns an empty list. - [Get a record set for a change list](https://techdocs.akamai.com/edge-dns/reference/get-changelists-zone-names-name-types-type.md): Returns an individual record set based on the selected change list. The record sets returned reflects any changes added to this change list. Record sets are annotated with the related change as clean, modified, new, or deleted. This call works even if the change list is stale. - [Upload a master zone file to a change list](https://techdocs.akamai.com/edge-dns/reference/post-changelists-zone-recordsets.md): Replaces your change list's record sets with the contents of a master zone file. - [List record sets for a change list](https://techdocs.akamai.com/edge-dns/reference/get-changelists-zone-recordsets.md): Retrieves the current record sets based on the selected change list. The record sets returned reflect any Changes added to this change list. This call works even if the change list is stale. This operation is (paginated](ref:use-pagination). - [Modify record set for a change list](https://techdocs.akamai.com/edge-dns/reference/post-changelists-zone-recordsets-add-change.md): Adds a record set change to this change list. Each change is an operation that affects a single record set: `ADD`, `EDIT`, or `DELETE`. - [List authoritative name servers](https://techdocs.akamai.com/edge-dns/reference/get-data-authorities.md): Retrieves the currently assigned Akamai authoritative name servers for one or more contracts. - [List contracts](https://techdocs.akamai.com/edge-dns/reference/get-data-contracts.md): Lists the contracts accessible to the current user. Each contract includes the features and permissions that are available to you on that contract. - [List DNSSEC algorithms](https://techdocs.akamai.com/edge-dns/reference/get-data-dns-sec-algorithms.md): Retrieves DNSSEC algorithm names. - [List edge hostnames](https://techdocs.akamai.com/edge-dns/reference/get-data-edgehostnames.md): Displays Edge hostnames that have been configured for the current customer. - [List groups](https://techdocs.akamai.com/edge-dns/reference/get-data-groups.md): Lists the groups accessible to the current user. Each group includes the contracts related to that group, as well as your permissions of `READ`, `WRITE`, `ADD`, or `DELETE` zone on that group. - [List TSIG key algorithms](https://techdocs.akamai.com/edge-dns/reference/get-data-tsig-algorithms.md): Retrieves TSIG algorithm names. - [List record types](https://techdocs.akamai.com/edge-dns/reference/get-record-set-types.md): Retrieves record types you can add to the requested zone. Record types depend on both the zone type and the available contract features. - [Submit a bulk zone create request](https://techdocs.akamai.com/edge-dns/reference/post-zones-create-requests.md): Submits a request to create one or more new Zones asynchronously. The request body contains a JSON array. Each object in the array contains the data necessary to create a zone. All zones are created on the same contract and group. An offline task creates the new zones. You can use the response's `requestId` to check the task's status and view its results once it completes. - [Check bulk zone create status](https://techdocs.akamai.com/edge-dns/reference/get-zones-create-requests-requestid.md): Retrieves the current status of a running or completed request. The `requestId` was returned when the create request was initiated. - [Get bulk zone create results](https://techdocs.akamai.com/edge-dns/reference/get-zones-create-requests-requestid-result.md): Retrieves the results from a completed request. - [Search bulk zone convert requests](https://techdocs.akamai.com/edge-dns/reference/get-zones-convert-requests.md): Search convert requests. - [Submit a bulk zone convert alias request](https://techdocs.akamai.com/edge-dns/reference/post-zones-convert-alias-requests.md): Submits a request to convert one or more zones to alias asynchronously. The request body contains a JSON array. Each object in the array contains the data necessary to convert to an alias zone. All zones are converted on the same contract and group. An offline task converts the zones. You can use the response's `requestId` to check the task's status and view its results once it completes. - [Submit a bulk zone convert primary request](https://techdocs.akamai.com/edge-dns/reference/post-zones-convert-primary-requests.md): Submits an asynchronous request to convert one or more DNS zones to primary. The request body must be a JSON array, where each object provides the required data for converting a zone. All zones included in the request must belong to the same contract and group. The conversion is performed as an offline task. Use the requestId returned in the response to track the task’s progress and retrieve the results upon completion. - [Submit a bulk zone convert secondary request](https://techdocs.akamai.com/edge-dns/reference/post-zones-convert-secondary-requests.md): Submits an asynchronous request to convert one or more DNS zones to secondary. The request body must be a JSON array, with each object containing the required data for the conversion. All zones must belong to the same contract and group. The conversion is handled by an offline task. Use the `requestId` returned in the response to monitor the task's progress and retrieve the results when complete. - [List SOA serials for secondary zones](https://techdocs.akamai.com/edge-dns/reference/post-zones-convert-serials-requests.md): Submits a request to retrieve SOA serial numbers for secondary zones only. If a serial number cannot be retrieved from the back end for a given zone, the corresponding zone/soaSerialLock object will be omitted from the response list. - [Check bulk zone convert status](https://techdocs.akamai.com/edge-dns/reference/get-zones-convert-requests-requestid.md): Retrieves the current status of a running or completed zone conversion request. The `requestId` is returned when the conversion request is initiated. - [Get bulk zone convert results](https://techdocs.akamai.com/edge-dns/reference/get-zones-convert-requests-requestid-result.md): Retrieves the results from a completed request. - [Submit a bulk zone delete request](https://techdocs.akamai.com/edge-dns/reference/post-zones-delete-requests.md): Submits a request to delete one or more new Zones asynchronously. The request body contains a JSON array. Each element in the array is the name of a zone to be deleted. Before deleting a zone from the Edge DNS system, the API makes sure Akamai servers aren't receiving DNS requests for that zone. It also checks that the zone isn't currently delegated to Akamai's name servers. An offline task deletes the new zones. The result of this operation is a `requestId`, which you can use to check the task's status and view its results once it completes. - [Check bulk zone delete status](https://techdocs.akamai.com/edge-dns/reference/get-zones-delete-requests-requestid.md): Retrieves the current status of a running or completed request. The `requestId` was returned when the delete request was initiated. - [Get bulk zone delete results](https://techdocs.akamai.com/edge-dns/reference/get-zones-delete-requests-requestid-result.md): Retrieves the `results` from a completed request. - [List TSIG keys](https://techdocs.akamai.com/edge-dns/reference/get-keys.md): Get the TSIG keys used by zones that you're allowed to manage. - [Update a TSIG key across zones](https://techdocs.akamai.com/edge-dns/reference/post-keys-bulk-update.md): This updates the key data for multiple zones at once. Keep in mind that this operation can only add zones to a TSIG key, not remove them. To safely remove the association between a zone and a TSIG key, update the zone to its new TSIG key or remove the key from the zone if you're sure it's no longer needed. - [List zones using TSIG key](https://techdocs.akamai.com/edge-dns/reference/post-keys-used-by.md): Returns zone names that use the given TSIG key and for which the current user has READ access. If the zones returned is empty, it's possible that the given key is in use by other zones but the current user doesn't have permission to view those zones. - [Zones to contract using TSIG key](https://techdocs.akamai.com/edge-dns/reference/post-keys-used-by-zone-contract-map.md): Zone names within a contract that use the given TSIG key for which the current user has READ access. If the list returned is empty, it's possible that the given key is in use by other zones but the current user doesn't have permission to view those zones. - [Get a zone's TSIG key](https://techdocs.akamai.com/edge-dns/reference/get-zones-zone-key.md): Retrieves the TSIG Key data for this zone. Includes a count of zones that use this key. Returns a 404 error if the zone doesn't have a TSIG key. - [Update a zone's TSIG key](https://techdocs.akamai.com/edge-dns/reference/put-zones-zone-key.md): Creates or replaces the current TSIG Key for this zone. If other zones use the same key, doesn't modify those zones. - [Delete a zone's TSIG key](https://techdocs.akamai.com/edge-dns/reference/delete-zones-zone-key.md): Removes the TSIG Key for this zone. This action doesn't affect any other zone, even if they share the same TSIG key as this zone. If the zone doesn't currently have a key, no actions are taken and no error is thrown. - [List users of a zone's TSIG key](https://techdocs.akamai.com/edge-dns/reference/get-zones-zone-key-used-by.md): Lists the Zones that use the same TSIG key as this zone. - [Create a proxy](https://techdocs.akamai.com/edge-dns/reference/post-proxy.md): Creates a new proxy. - [List proxies](https://techdocs.akamai.com/edge-dns/reference/get-proxy.md): Get all proxies that the current user has access to manage. - [List valid proxy health check record set types](https://techdocs.akamai.com/edge-dns/reference/get-proxy-healthcheck-recordset-types.md): Lists the valid proxy health check record set types. - [Get a proxy](https://techdocs.akamai.com/edge-dns/reference/get-proxy-id.md): Get the proxy that the current user has access to manage. - [Update a proxy](https://techdocs.akamai.com/edge-dns/reference/put-proxy.md): Updates the proxy. - [Delete a proxy](https://techdocs.akamai.com/edge-dns/reference/delete-proxy.md): Delete the proxy as an asynchronous operation. Your proxy will continue to show with a `DELETED` status and continue to count against your maximum proxy cap until permanently removed. - [List proxy zones](https://techdocs.akamai.com/edge-dns/reference/get-proxy-zones.md): Get all proxy zones that the current user has access to manage. - [List proxy zone keys](https://techdocs.akamai.com/edge-dns/reference/get-proxy-zone-keys.md): Get all proxy zones keys that the current user has access to manage. - [Get a proxy zone by name](https://techdocs.akamai.com/edge-dns/reference/get-proxy-zones-name.md): Get a proxy zone that the current user has access to manage by proxy zone name. - [Save the apex alias for a proxy zone](https://techdocs.akamai.com/edge-dns/reference/put-proxy-zone-apex-alias.md): Save the apex alias for a proxy zone. - [Delete apex alias for a proxy zone](https://techdocs.akamai.com/edge-dns/reference/delete-proxy-zone-apex-alias.md): Delete the apex alias for a proxy zone. - [Get a proxy zone TSIG key by name](https://techdocs.akamai.com/edge-dns/reference/get-proxy-zones-name-key.md): Get a TSIG key for a proxy zone that the current user has access to manage by proxy zone name. - [Update a proxy zone TSIG key by name](https://techdocs.akamai.com/edge-dns/reference/put-proxy-zones-name-key.md): Update the proxy zone. - [Delete a proxy zone TSIG key by name](https://techdocs.akamai.com/edge-dns/reference/delete-proxy-zones-name-key.md): Delete a TSIG key for a proxy zone that the current user has access to manage by proxy zone name. - [List proxies for a TSIG key](https://techdocs.akamai.com/edge-dns/reference/get-proxies-key-used-by.md): List proxies that use a TSIG key. - [Get a manual filter report](https://techdocs.akamai.com/edge-dns/reference/get-proxy-zone-manual-filter-report.md): Get manual filter report for a proxy zone that the current user has access to manage. - [Manage manual filter names](https://techdocs.akamai.com/edge-dns/reference/post-proxy-zone-manual-filter-names.md): Manage manual filter entries for a proxy zone that the current user has access to manage. - [Initialize manual filter names with a zone file](https://techdocs.akamai.com/edge-dns/reference/post-proxy-zone-manual-filter-names-file.md): Initializes manual filter names for a proxy zone. Use [Manage manual filter names operation](ref:post-proxy-zone-manual-filter-names) to update a proxy zone. - [Convert a proxy zone filter mode to all](https://techdocs.akamai.com/edge-dns/reference/post-proxy-zone-manual-filter-mode-convert-all.md): Converts a proxy zone filter mode to all. - [Convert a proxy zone filter mode to automatic](https://techdocs.akamai.com/edge-dns/reference/post-proxy-zone-manual-filter-mode-convert-automatic.md): Converts a proxy zone filter mode to automatic. - [Convert a proxy zone filter mode to manual](https://techdocs.akamai.com/edge-dns/reference/post-proxy-zone-manual-filter-mode-convert-manual.md): Converts a proxy zone filter mode to manual. - [Convert a proxy zone filter mode to none](https://techdocs.akamai.com/edge-dns/reference/post-proxy-zone-manual-filter-mode-convert-none.md): Converts a proxy zone filter mode to none. - [Run existing proxy health check](https://techdocs.akamai.com/edge-dns/reference/post-run-proxy-healthcheck.md): Runs the health check currently defined on the proxy. - [Run proposed proxy health check for origin name servers](https://techdocs.akamai.com/edge-dns/reference/post-run-proposed-proxy-healthcheck.md): Runs a proposed health check on the proxy. - [Submit a bulk proxy zone create request](https://techdocs.akamai.com/edge-dns/reference/post-proxy-zones-create-requests.md): Submits a request to create one or more new Proxy Zones asynchronously. The request body contains a JSON array. Each object in the array contains the data necessary to create a proxy zone. All proxy zones are created on the same contract and group. An offline task creates the new proxy zones. You can use the response's `requestId` to check the task's status and view its results once it completes. - [Get a bulk proxy zone create results for a proxy](https://techdocs.akamai.com/edge-dns/reference/get-proxy-zones-create-requests-result.md): Retrieves the results of requests for a given proxy. - [Check bulk proxy zone create status](https://techdocs.akamai.com/edge-dns/reference/get-proxy-zones-create-requests-requestid.md): Retrieves the current status of a running or completed request. The `requestId` was returned when the create request was initiated. - [Get a bulk proxy zone create result](https://techdocs.akamai.com/edge-dns/reference/get-proxy-zones-create-requests-requestid-result.md): Retrieves the results from a completed request. - [Submit a bulk proxy zone delete request](https://techdocs.akamai.com/edge-dns/reference/post-proxy-zones-delete-requests.md): Submits a request to delete one or more proxy zones asynchronously. Each element in the response array is the name of a proxy zone to be deleted. Before deleting a zone from the Edge DNS system, the API makes sure Akamai servers aren't receiving DNS requests for that proxy zone. It also checks that the proxy zone isn't currently delegated to Akamai's name servers. An offline task deletes the proxy zones. The result of this operation is a `requestId`, which you can use to check the task's status and view its results once it completes. - [Get all bulk proxy zone delete results](https://techdocs.akamai.com/edge-dns/reference/get-proxy-zones-delete-requests-result.md): Retrieves the results for all requests for a given proxy. - [Check bulk proxy zone delete status](https://techdocs.akamai.com/edge-dns/reference/get-proxy-zones-delete-requests-requestid.md): Retrieves the current status of a running or completed request. The `requestId` was returned when the delete request was initiated. - [Get a bulk proxy zone delete result](https://techdocs.akamai.com/edge-dns/reference/get-proxy-zones-delete-requests-requestid-result.md): Retrieves the result from a completed request. - [List record set names for a zone](https://techdocs.akamai.com/edge-dns/reference/get-zone-names.md): Retrieves record set names for a zone. - [Upload a master zone file](https://techdocs.akamai.com/edge-dns/reference/post-zones-zone-zone-file.md): Upload new record set data for this zone in master zone file format. Replaces any existing record sets. This operation applies to primary zones and secondary zones. See [RFC 1035](http://tools.ietf.org/html/rfc1035) section 5 and [RFC 1034](http://tools.ietf.org/html/rfc1034) section 3.6.1 for more information. Zone files can contain only US-ASCII characters 0–127. Where allowed, you can encode high-order ASCII characters, 128+, with a backslash plus a three-digit decimal number representing the byte value. For example, `\233` instead of `é`. `AKAMAICDN` and `AKAMAITLC` records can't be represented in this format. Uploading a zone file doesn't affect these records. - [Get a master zone file](https://techdocs.akamai.com/edge-dns/reference/get-zones-zone-zone-file.md): Download this zone's record set data in master zone file format. Use the recipe below to get the master zone file. This operation applies to primary zones and secondary zones. See [RFC 1035](http://tools.ietf.org/html/rfc1035) section 5 and [RFC 1034](http://tools.ietf.org/html/rfc1034) section 3.6.1 for more information. `AKAMAICDN` and `AKAMAITLC` records can't be represented in this format, so they're displayed as comment lines. - [List record set types for name and zone](https://techdocs.akamai.com/edge-dns/reference/get-zone-name-types.md): Lists all *existing* record set types for this name. The types are available at [List record types](ref:get-record-set-types). If the name doesn't exist within the zone, an empty list is returned. - [Create a record set](https://techdocs.akamai.com/edge-dns/reference/post-zones-zone-names-name-types-type.md): Creates a new Record set with the specified name and type. - [Get a record set](https://techdocs.akamai.com/edge-dns/reference/get-zone-name-type.md): Retrieves a single record set for the zone, record name, and record type specified in the URL. - [Replace a record set](https://techdocs.akamai.com/edge-dns/reference/put-zones-zone-names-name-types-type.md): Replaces an existing Record set with the request body. The `name` and `type` need to match the existing record. - [Delete a record set](https://techdocs.akamai.com/edge-dns/reference/delete-zone-name-type.md): Removes an existing record set. - [Create record sets](https://techdocs.akamai.com/edge-dns/reference/post-zones-zone-recordsets.md): Creates multiple new record sets on this Zone. If any record set fails to create, for example, because a record set with that name and type already exists, the entire operation fails. - [Get a zone's record sets](https://techdocs.akamai.com/edge-dns/reference/get-zones-zone-recordsets.md): Lists all record sets for this Zone. It works only for `PRIMARY` and `SECONDARY` zones. This operation is [paginated](ref:use-pagination). - [Replace record sets](https://techdocs.akamai.com/edge-dns/reference/put-zones-zone-recordsets.md): Replaces all record sets that currently exist with the list provided. ## Recipes - [Create a record set](https://techdocs.akamai.com/edge-dns/recipes/create-a-record-set.md) - [Create a zone](https://techdocs.akamai.com/edge-dns/recipes/create-a-zone.md) - [Create multiple record sets](https://techdocs.akamai.com/edge-dns/recipes/create-multiple-record-sets.md) - [Get a record set](https://techdocs.akamai.com/edge-dns/recipes/get-a-record-set.md) - [Get a version's master zone file](https://techdocs.akamai.com/edge-dns/recipes/get-a-versions-master-zone-file.md) - [Get a zone version](https://techdocs.akamai.com/edge-dns/recipes/get-a-zone-version.md) - [Get secondary zone's transfer status](https://techdocs.akamai.com/edge-dns/recipes/get-secondary-zones-transfer-status.md) - [Get version's record sets](https://techdocs.akamai.com/edge-dns/recipes/get-versions-record-sets.md) - [Get zone's contract](https://techdocs.akamai.com/edge-dns/recipes/get-zones-contract.md) - [Get zones DNSSEC status](https://techdocs.akamai.com/edge-dns/recipes/get-zones-dnssec-status.md) - [Get zone's settings](https://techdocs.akamai.com/edge-dns/recipes/get-zones-settings.md) - [Modify a record set for a change list](https://techdocs.akamai.com/edge-dns/recipes/modify-a-record-set-for-a-change-list.md) - [Reactivate a zone version](https://techdocs.akamai.com/edge-dns/recipes/reactivate-a-zone-version.md) - [Show differences](https://techdocs.akamai.com/edge-dns/recipes/show-differences.md) - [Submit bulk-create request](https://techdocs.akamai.com/edge-dns/recipes/submit-bulk-create-request.md) - [Update TSIG key for zones](https://techdocs.akamai.com/edge-dns/recipes/update-tsig-key-for-zones.md) ## Changelog - [Mar 25, 2026 — Edge DNS and Shield NS53 updates](https://techdocs.akamai.com/edge-dns/changelog/mar-25-2026-edge-dns-and-shield-ns53-updates.md) - [Jul 23, 2025 — Edge DNS and Shield NS53 updates](https://techdocs.akamai.com/edge-dns/changelog/jul-23-2025-edge-dns-updates.md) - [Jan 23, 2025 — Edge DNS updates](https://techdocs.akamai.com/edge-dns/changelog/jan-23-2025-edge-dns-updates.md) - [Jul 01, 2024 — Edge DNS updates](https://techdocs.akamai.com/edge-dns/changelog/jul-01-2024-edge-dns-updates.md) - [Jan 03, 2024 — Edge DNS updates](https://techdocs.akamai.com/edge-dns/changelog/jan-03-2024.md) # Edge IP Binding Documentation > Akamai's Edge IP Binding (EIPB) lets you deliver traffic from a small, static set of IP addresses in an scalable manner. ## Guides - [Welcome to Edge IP Binding](https://techdocs.akamai.com/edge-ip-binding/docs/welcome-edge-ip-binding.md) - [How Edge IP Binding works](https://techdocs.akamai.com/edge-ip-binding/docs/how-does-eipb-work.md) - [Before you begin](https://techdocs.akamai.com/edge-ip-binding/docs/before-can-use-eipb.md) - [Use standard TLS (HTTPS)](https://techdocs.akamai.com/edge-ip-binding/docs/eipb-standard-tls-https.md) - [Use enhanced TLS (HTTPS)](https://techdocs.akamai.com/edge-ip-binding/docs/eipb-enhanced-tls-https.md) - [Use a shared cert hostname (HTTPS)](https://techdocs.akamai.com/edge-ip-binding/docs/eipb-shared-cert-hn-https.md) - [Use a custom hostname (HTTP)](https://techdocs.akamai.com/edge-ip-binding/docs/eipb-custom-edge-hn-http.md) - [Use an instant config hostname (HTTP)](https://techdocs.akamai.com/edge-ip-binding/docs/eipb-instant-config-hn-http.md) - [View the Edge IP Binding addresses](https://techdocs.akamai.com/edge-ip-binding/docs/where-my-eipb-addr.md) - [Reuse IPs](https://techdocs.akamai.com/edge-ip-binding/docs/reuse-ips.md) - [About the Edge IP Binding tool](https://techdocs.akamai.com/edge-ip-binding/docs/edge-ip-binding-tool.md) - [Create a configuration](https://techdocs.akamai.com/edge-ip-binding/docs/create-an-edge-ip-binding-configuration.md) - [Get your addresses](https://techdocs.akamai.com/edge-ip-binding/docs/get-eipb-addresses.md) - [View a configuration](https://techdocs.akamai.com/edge-ip-binding/docs/whats-revealed-eipb-config.md) - [Edit a configuration](https://techdocs.akamai.com/edge-ip-binding/docs/edit-eipb-config.md) - [Remove a configuration](https://techdocs.akamai.com/edge-ip-binding/docs/delete-deactivate-eipb-config.md) - [Hash Serial and Forward](https://techdocs.akamai.com/edge-ip-binding/docs/how-add-hsaf-eipb.md) - [Autonomous System Number Split](https://techdocs.akamai.com/edge-ip-binding/docs/how-add-asn-split-eipb.md) ## Changelog - [Dec 21, 2021 — New Edge IP Binding documentation experience](https://techdocs.akamai.com/edge-ip-binding/changelog/dec-21-2021-new-edge-ip-binding-documentation-experience.md) # EdgeKV Documentation > Akamai's EdgeKV is a key-value store database at the edge. It enables you to build data-driven EdgeWorker applications that require fast, frequent reads and infrequent writes. ## Guides - [Welcome to EdgeKV](https://techdocs.akamai.com/edgekv/docs/welcome-to-edgekv.md) - [EdgeKV data model](https://techdocs.akamai.com/edgekv/docs/edgekv-data-model.md) - [Use Cases](https://techdocs.akamai.com/edgekv/docs/use-cases.md) - [Augment Image and Video Manager with edge compute](https://techdocs.akamai.com/edgekv/docs/augment-image-and-video-manager-with-edge-compute.md) - [Send a constructed response to a web page](https://techdocs.akamai.com/edgekv/docs/send-a-constructed-response-to-a-web-page.md) - [Add EdgeKV to your contract](https://techdocs.akamai.com/edgekv/docs/add-edgekv-to-your-contract.md) - [Manage access to EdgeKV](https://techdocs.akamai.com/edgekv/docs/manage-access-to-edgekv.md) - [Generate and retrieve EdgeKV access tokens](https://techdocs.akamai.com/edgekv/docs/generate-and-retrieve-edgekv-access-tokens.md) - [Use the API to generate and retrieve EdgeKV access tokens](https://techdocs.akamai.com/edgekv/docs/use-the-api-generate-and-retrieve-edgekv-access-tokens-1.md) - [Use the CLI to generate and manage access tokens](https://techdocs.akamai.com/edgekv/docs/use-the-cli-to-generate-and-manage-access-tokens.md) - [API Hello world](https://techdocs.akamai.com/edgekv/docs/api-hello-world.md) - [Create an EdgeWorkers function](https://techdocs.akamai.com/edgekv/docs/create-an-edgeworkers-function.md) - [Initialize the EdgeKV database](https://techdocs.akamai.com/edgekv/docs/initialize-the-edgekv-database-1.md) - [Download the helper library](https://techdocs.akamai.com/edgekv/docs/download-the-helper-library-1.md) - [Add data to your database](https://techdocs.akamai.com/edgekv/docs/add-data-to-your-database.md) - [Create a code bundle](https://techdocs.akamai.com/edgekv/docs/create-a-code-bundle-1.md) - [Activate your EdgeWorkers function](https://techdocs.akamai.com/edgekv/docs/activate-your-edgeworkers-function.md) - [CLI Hello world](https://techdocs.akamai.com/edgekv/docs/cli-hello-world.md) - [Create an EdgeWorkers function](https://techdocs.akamai.com/edgekv/docs/create-an-edgeworkers-function-1.md) - [Initialize the EdgeKV database](https://techdocs.akamai.com/edgekv/docs/initialize-the-edgekv-database-2.md) - [Download the helper library](https://techdocs.akamai.com/edgekv/docs/download-the-helper-library.md) - [Add data to your EdgeKV database](https://techdocs.akamai.com/edgekv/docs/add-data-to-your-edgekv-database-1.md) - [Create a code bundle](https://techdocs.akamai.com/edgekv/docs/create-a-code-bundle-2.md) - [Activate your EdgeWorkers function](https://techdocs.akamai.com/edgekv/docs/activate-your-edgeworkers-function-1.md) - [Helper library](https://techdocs.akamai.com/edgekv/docs/library-helper-methods.md) - [Best practices](https://techdocs.akamai.com/edgekv/docs/best-practices.md) - [Data model design](https://techdocs.akamai.com/edgekv/docs/best-practices-for-data-model-design.md) - [Access tokens](https://techdocs.akamai.com/edgekv/docs/access-tokens-1.md) - [FAQ](https://techdocs.akamai.com/edgekv/docs/frequently-asked-questions.md) - [General questions](https://techdocs.akamai.com/edgekv/docs/general-questions.md) - [Access tokens](https://techdocs.akamai.com/edgekv/docs/access-tokens.md) - [Performance](https://techdocs.akamai.com/edgekv/docs/performance.md) - [Throughput](https://techdocs.akamai.com/edgekv/docs/throughput.md) - [Sandbox support for EdgeKV](https://techdocs.akamai.com/edgekv/docs/sandbox-support-edgekv.md) - [Akamai CLI](https://techdocs.akamai.com/edgekv/docs/akamai-cli.md) - [Troubleshoot issues](https://techdocs.akamai.com/edgekv/docs/troubleshoot.md) - [View reports](https://techdocs.akamai.com/edgekv/docs/reporting.md) - [Product limits](https://techdocs.akamai.com/edgekv/docs/limits.md) - [Known issues](https://techdocs.akamai.com/edgekv/docs/known-issues.md) ## API Reference - [EdgeKV API](https://techdocs.akamai.com/edgekv/reference/api.md) - [API summary](https://techdocs.akamai.com/edgekv/reference/api-summary.md) - [Get started](https://techdocs.akamai.com/edgekv/reference/api-get-started.md) - [Errors](https://techdocs.akamai.com/edgekv/reference/api-errors.md) - [400](https://techdocs.akamai.com/edgekv/reference/400.md) - [401](https://techdocs.akamai.com/edgekv/reference/401.md) - [403](https://techdocs.akamai.com/edgekv/reference/403.md) - [404](https://techdocs.akamai.com/edgekv/reference/404.md) - [405](https://techdocs.akamai.com/edgekv/reference/405.md) - [406](https://techdocs.akamai.com/edgekv/reference/406.md) - [409](https://techdocs.akamai.com/edgekv/reference/409.md) - [410](https://techdocs.akamai.com/edgekv/reference/410.md) - [413](https://techdocs.akamai.com/edgekv/reference/413.md) - [415](https://techdocs.akamai.com/edgekv/reference/415.md) - [422](https://techdocs.akamai.com/edgekv/reference/422.md) - [429](https://techdocs.akamai.com/edgekv/reference/429.md) - [500](https://techdocs.akamai.com/edgekv/reference/500.md) - [501](https://techdocs.akamai.com/edgekv/reference/501.md) - [504](https://techdocs.akamai.com/edgekv/reference/504.md) - [Get the EdgeKV initialization status](https://techdocs.akamai.com/edgekv/reference/get-initialize.md): View the EdgeKV initialization status. - [Initialize EdgeKV](https://techdocs.akamai.com/edgekv/reference/put-initialize.md): You only need to initialize EdgeKV once. This operation adds the `default` EdgeKV namespace to Akamai's `STAGING` and `PRODUCTION` networks. It also creates a new dedicated CP code for you to track your EdgeKV usage. You won't be able to use any of the EdgeKV API operations or your EdgeKV database until initialization completes. You should only use the `default` namespace for experimentation and testing purposes. When deploying your EdgeKV database in production, use a new namespace with a different name. You can also specify a `dataAccessPolicy` to run this operation. The `dataAccessPolicy` determines if you can create new namespaces only on Akamai’s Enhanced TLS network, or both the Enhanced TLS and Standard TLS networks. By default, all existing namespaces use only the Enhanced TLS network. - [Create an access token](https://techdocs.akamai.com/edgekv/reference/post-tokens.md): Generate an access token that allows an EdgeWorkers code bundle to access the specified namespace. Any new tokens that you create refresh automatically without expiring. You don't need to update tokens inside your `edgekv_tokens.js` file. Tokens created before the enhanced token workflow implementation will still expire. You need to replace these expired tokens in your code bundle. To learn more about access tokens, refer to the [EdgeKV guide](doc:generate-and-retrieve-edgekv-access-tokens). - [List access tokens](https://techdocs.akamai.com/edgekv/reference/get-tokens.md): View a list of EdgeKV access tokens. - [Download an access token](https://techdocs.akamai.com/edgekv/reference/get-token.md): Download a previously created EdgeKV access token. To get a token, you need to know the token `name`. Tokens created using the enhanced token workflow don't include the JWT value in the response. To learn more about access tokens, refer to the [EdgeKV guide](doc:generate-and-retrieve-edgekv-access-tokens). - [Revoke an access token](https://techdocs.akamai.com/edgekv/reference/delete-token.md): Once you revoke an access token, you can't undo it. You also need to update any deployed EdgeWorkers code bundles that use the old token with a new token, or requests to EdgeKV fail. Any requests from an EdgeWorkers code bundle using a revoked token cause a 401 error. To learn more about access tokens, refer to the [EdgeKV guide](doc:generate-and-retrieve-edgekv-access-tokens). - [Refresh an access token](https://techdocs.akamai.com/edgekv/reference/post-refresh-token.md): Refresh a previously created EdgeKV access token before scheduled automatic refresh. - [List permission groups](https://techdocs.akamai.com/edgekv/reference/get-groups.md): View a list of access groups and your associated permission capabilities, such as create a namespace or read data from a namespace. - [Get a permission group](https://techdocs.akamai.com/edgekv/reference/get-group.md): View details permissions available within the specified access group, such as create a namespace or read data from a namespace. - [Modify the default data access policy](https://techdocs.akamai.com/edgekv/reference/put-auth-database.md): Modify the default `dataAccessPolicy` setting that applies to new namespaces. The `restrictDataAccess` is `true` by default, and `allowNamespacePolicyOverride` is `false`. - [Reauthorize a namespace](https://techdocs.akamai.com/edgekv/reference/reauthorize-namespace.md): Assign an existing namespace to a different Akamai access group. - [List items within a group](https://techdocs.akamai.com/edgekv/reference/get-group-items.md): View the details of an EdgeKV item (key-value pair) within a group. You need to specify the `namespace` and `group` the item belongs to. This operation returns up to 100 items by default or the number of items specified in the `maxItems`. If there are more than the default or requested items in the specified group, the operation returns a random set of the default or requested items. It can take ten seconds or longer to read an item that has been written to EdgeKV. The API may respond with a 404 error during that period. This is normal behavior for EdgeKV, which is an eventually consistent database. - [Read an item](https://techdocs.akamai.com/edgekv/reference/get-item.md): Read an EdgeKV item. You need to specify the `namespace` and `group` the item belongs to. It can take ten seconds or longer to read an item that has been recently written to EdgeKV. The API may return a 404 error during that period. This is normal behavior for EdgeKV, which is an eventually consistent database. - [Write an item](https://techdocs.akamai.com/edgekv/reference/put-item.md): Create or update an EdgeKV item (name-value). You need to specify the `namespace` and `group` the item belongs to. The target `namespace` must already exist before writing, while the `group` is automatically created for you if it doesn't exist yet. - [Delete an item](https://techdocs.akamai.com/edgekv/reference/delete-item.md): Mark an EdgeKV item for deletion. You need to specify the `namespace` and `group` the item belongs to. It can take ten seconds or longer for a deleted item to be removed from the database. If you attempt a read operation before the value has been updated globally, stale data may be returned until the update is complete. This is normal behavior for EdgeKV, which is an eventually consistent database. - [Create a namespace](https://techdocs.akamai.com/edgekv/reference/post-namespace.md): Creates a namespace on Akamai's `STAGING` or `PRODUCTION` network. You should create namespaces in both networks so that you can test your EdgeWorkers code on staging. - [List namespaces](https://techdocs.akamai.com/edgekv/reference/get-namespaces.md): View a list of all EdgeKV namespaces. - [Get namespace details](https://techdocs.akamai.com/edgekv/reference/get-namespace.md): View details for the specified namespace. - [Update namespace details](https://techdocs.akamai.com/edgekv/reference/put-namespace.md): You can update the retention period for any existing namespace other than the default namespace. It can take up to five minutes for a new retention policy to apply. The new retention period only applies to data added or updated in the namespace after this operation is complete. The retention period of existing data remains unchanged from the old retention period. Once you perform this operation you can't query the previously existing data. If you want to ensure that all data in the namespace has the same retention period you need to update the entire data set once the retention period has been updated. To change the access group used to authorize permission to a namespace, see [Reauthorize a namespace](https://techdocs.akamai.com/edgekv/reference/reauthorize-namespace). If you try to run this operation to update the access group, you get a [400 error](https://techdocs.akamai.com/edgekv/reference/400). - [Delete namespace](https://techdocs.akamai.com/edgekv/reference/delete-namespace.md): Delete a namespace and all of its contents. - [List groups within a namespace](https://techdocs.akamai.com/edgekv/reference/get-namespace-groups.md): List group identifiers created when writing items to a namespace. You need to specify at least one of these group identifiers in the `groupId` parameter when writing items to a specific namespace. The group identifier is a logical container for a set of items stored inside a given namespace. - [Download namespace data](https://techdocs.akamai.com/edgekv/reference/get-namespace-download.md): Download all content stored within the namespace. - [Get namespace delete time](https://techdocs.akamai.com/edgekv/reference/get-scheduled-delete.md): View the scheduled time for a namespace delete. - [Reschedule a namespace delete](https://techdocs.akamai.com/edgekv/reference/put-scheduled-delete.md): Change the scheduled time of a namespace delete. - [Download group data](https://techdocs.akamai.com/edgekv/reference/get-group-download.md): Download all content stored within the group. - [Cancel a scheduled namespace delete](https://techdocs.akamai.com/edgekv/reference/delete-scheduled-delete.md): This deletes the scheduled time for a namespace delete, effectively canceling the deletion. You need to cancel a namespace delete at least five minutes before the scheduled deletion time. You can't cancel a namespace delete scheduled to occur in five minutes or less. - [Get namespace upload job details](https://techdocs.akamai.com/edgekv/reference/get-namespace-upload-job.md): View details about a specific namespace upload job. - [Upload namespace data](https://techdocs.akamai.com/edgekv/reference/post-namespace-upload.md): Upload CSV-formatted data into a namespace. The CSV syntax generally follows RFC 4180, but allows empty lines, which are ignored. Each line needs at least three comma-delimited fields: the `groupId`, `itemId`, and item content for the namespace. An optional fourth field defines the number of seconds the item is retained. If this field is absent, the namespace's `retentionInSeconds` applies. - [List upload jobs](https://techdocs.akamai.com/edgekv/reference/get-namespace-upload.md): View a list of all upload jobs for a namespace. ## Recipes - [Create a namespace](https://techdocs.akamai.com/edgekv/recipes/create-a-namespace.md) - [Create an access token](https://techdocs.akamai.com/edgekv/recipes/create-an-access-token.md) - [Delete an item](https://techdocs.akamai.com/edgekv/recipes/delete-an-item.md) - [Download an access token](https://techdocs.akamai.com/edgekv/recipes/download-an-access-token.md) - [Download group data](https://techdocs.akamai.com/edgekv/recipes/download-group-data.md) - [Download namespace data](https://techdocs.akamai.com/edgekv/recipes/download-namespace-data.md) - [Get a permission group](https://techdocs.akamai.com/edgekv/recipes/get-a-permission-group.md) - [Get namespace details](https://techdocs.akamai.com/edgekv/recipes/get-namespace-details.md) - [Get namespace upload job details](https://techdocs.akamai.com/edgekv/recipes/get-namespace-upload-job-details.md) - [Get the EdgeKV initialization status](https://techdocs.akamai.com/edgekv/recipes/get-the-edgekv-initialization-status.md) - [Initialize EdgeKV](https://techdocs.akamai.com/edgekv/recipes/initialize-edgekv.md) - [List access tokens](https://techdocs.akamai.com/edgekv/recipes/list-access-tokens.md) - [List groups within a namespace](https://techdocs.akamai.com/edgekv/recipes/list-groups-within-a-namespace.md) - [List items within a group](https://techdocs.akamai.com/edgekv/recipes/list-items-within-a-group.md) - [List namespaces](https://techdocs.akamai.com/edgekv/recipes/list-namespaces.md) - [List permission groups](https://techdocs.akamai.com/edgekv/recipes/list-permission-groups.md) - [List upload jobs](https://techdocs.akamai.com/edgekv/recipes/list-upload-jobs.md) - [Read an item](https://techdocs.akamai.com/edgekv/recipes/read-an-item.md) - [Reauthorize a namespace](https://techdocs.akamai.com/edgekv/recipes/reauthorize-a-namespace.md) - [Revoke an access token](https://techdocs.akamai.com/edgekv/recipes/revoke-an-access-token.md) - [Update namespace details](https://techdocs.akamai.com/edgekv/recipes/update-namespace-details.md) - [Upload namespace data](https://techdocs.akamai.com/edgekv/recipes/upload-namespace-data.md) - [Write an item](https://techdocs.akamai.com/edgekv/recipes/write-an-item.md) ## Changelog - [Oct 6, 2025 — Bulk data import and export](https://techdocs.akamai.com/edgekv/changelog/bulk-data-import-export.md) - [Sep 3, 2024 — Enhanced token workflow & support for Standard TLS](https://techdocs.akamai.com/edgekv/changelog/aug-30-2024-token-refresh.md) - [Nov 13, 2024 - Delete a namespace](https://techdocs.akamai.com/edgekv/changelog/delete-namespace.md) - [Dec 19, 2023 — GLOBAL geoLocation for namespaces](https://techdocs.akamai.com/edgekv/changelog/dec-19-2023-new-global-geolocation.md) - [Oct 10, 2023 — Beta support for Standard TLS](https://techdocs.akamai.com/edgekv/changelog/standard-tls-beta-support.md) # EdgeWorkers Documentation > Use Akamai's EdgeWorkers service to execute JavaScript functions at the edge and create customized web experiences based on geolocation, device characteristics, and more. ## Guides - [Welcome to EdgeWorkers](https://techdocs.akamai.com/edgeworkers/docs/welcome-to-edgeworkers.md) - [EdgeWorkers event model](https://techdocs.akamai.com/edgeworkers/docs/event-handler-functions.md) - [Response orchestration](https://techdocs.akamai.com/edgeworkers/docs/response-orchestration.md) - [Administrator and developer roles](https://techdocs.akamai.com/edgeworkers/docs/administrator-and-developer-roles.md) - [Specifications](https://techdocs.akamai.com/edgeworkers/docs/specifications.md) - [Tutorials](https://techdocs.akamai.com/edgeworkers/docs/use-cases.md) - [Store locator](https://techdocs.akamai.com/edgeworkers/docs/store-locator.md): Learn how to execute store locator in a serverless function with EdgeWorkers - [Redirect pages based on location](https://techdocs.akamai.com/edgeworkers/docs/redirect-pages-based-on-location.md) - [Manifest and Playlist Manipulation](https://techdocs.akamai.com/edgeworkers/docs/manifest-and-playlist-personalization.md) - [Live program replacement](https://techdocs.akamai.com/edgeworkers/docs/live-program-replacement.md) - [Content insertion](https://techdocs.akamai.com/edgeworkers/docs/content-insertion.md) - [Response body processing](https://techdocs.akamai.com/edgeworkers/docs/process-response-bodies.md) - [Response content transformation](https://techdocs.akamai.com/edgeworkers/docs/transform-response-content.md) - [Dynamic Content Assembly using the html-rewriter](https://techdocs.akamai.com/edgeworkers/docs/html-rewriter-dynamic-content-assembly.md): Learn how to use the EdgeWorkers [html-rewriter](doc:htmlrewriter) to generate dynamic HTML content. - [Send analytic beacons without waiting for a response](https://techdocs.akamai.com/edgeworkers/docs/fire-and-forget.md): Fire and forget - Send beacons on each request, without waiting for a beacon collector response - [Use a Content Security Policy to cut latency, not security](https://techdocs.akamai.com/edgeworkers/docs/content-security-policy.md) - [Use npm package manager to import external modules](https://techdocs.akamai.com/edgeworkers/docs/import-external-module-npm-package-mgr.md): Unwrapping Packages - A guide to using external modules in EdgeWorkers - [Add EdgeWorkers to your contract](https://techdocs.akamai.com/edgeworkers/docs/add-edgeworkers-to-contract.md) - [EdgeWorkers free trial](https://techdocs.akamai.com/edgeworkers/docs/edgeworkers-free-trial.md) - [Manage access to EdgeWorkers](https://techdocs.akamai.com/edgeworkers/docs/manage-access-to-edgeworkers.md) - [Select a resource tier](https://techdocs.akamai.com/edgeworkers/docs/select-a-resource-tier.md) - [How to change to a different EdgeWorkers tier](https://techdocs.akamai.com/edgeworkers/docs/change-resource-tier.md) - [Hello World tutorials](https://techdocs.akamai.com/edgeworkers/docs/hello-world.md) - [EdgeWorkers Management application Hello World](https://techdocs.akamai.com/edgeworkers/docs/hello-world-edgeworkers-management-application.md) - [Create an EdgeWorker ID](https://techdocs.akamai.com/edgeworkers/docs/create-an-edgeworker-id-1.md) - [Add the EdgeWorker behavior](https://techdocs.akamai.com/edgeworkers/docs/add-the-edgeworker-behavior-1.md) - [Create the Hello World code bundle](https://techdocs.akamai.com/edgeworkers/docs/create-the-hello-world-code-bundle-1.md) - [Deploy Hello World](https://techdocs.akamai.com/edgeworkers/docs/deploy-hello-world-1.md) - [Test Hello World](https://techdocs.akamai.com/edgeworkers/docs/test-hello-world-1.md) - [API Hello World](https://techdocs.akamai.com/edgeworkers/docs/api-hello-world.md) - [Create an EdgeWorker ID](https://techdocs.akamai.com/edgeworkers/docs/create-an-edgeworker-id-2.md) - [Add the EdgeWorkers behavior](https://techdocs.akamai.com/edgeworkers/docs/add-the-edgeworkers-behavior-2.md) - [Create the Hello World code bundle](https://techdocs.akamai.com/edgeworkers/docs/create-the-hello-world-code-bundle-2.md) - [Deploy Hello World](https://techdocs.akamai.com/edgeworkers/docs/deploy-hello-world-2.md) - [Test Hello World](https://techdocs.akamai.com/edgeworkers/docs/test-hello-world-2.md) - [CLI Hello World](https://techdocs.akamai.com/edgeworkers/docs/cli-hello-world.md) - [Create an EdgeWorker ID](https://techdocs.akamai.com/edgeworkers/docs/create-an-edgeworker-id-3.md) - [Add the EdgeWorkers behavior](https://techdocs.akamai.com/edgeworkers/docs/add-the-edgeworkers-behavior-3.md) - [Create the Hello World code bundle](https://techdocs.akamai.com/edgeworkers/docs/create-the-hello-world-code-bundle-3.md) - [Deploy Hello World](https://techdocs.akamai.com/edgeworkers/docs/deploy-hello-world-3.md) - [Test Hello World](https://techdocs.akamai.com/edgeworkers/docs/test-hello-world-3.md) - [Set up the EdgeWorkers service](https://techdocs.akamai.com/edgeworkers/docs/set-up-the-edgeworkers-service.md) - [Create an EdgeWorker ID](https://techdocs.akamai.com/edgeworkers/docs/create-an-edgeworker-id.md) - [Add the EdgeWorkers behavior](https://techdocs.akamai.com/edgeworkers/docs/add-the-edgeworkers-behavior.md) - [Manage EdgeWorkers](https://techdocs.akamai.com/edgeworkers/docs/manage-edgeworkers.md) - [Error handling](https://techdocs.akamai.com/edgeworkers/docs/error-handling.md) - [Enable Continue on error](https://techdocs.akamai.com/edgeworkers/docs/continue-on-error.md) - [Configure Site Failover](https://techdocs.akamai.com/edgeworkers/docs/configure-site-failover.md) - [Test Site Failover](https://techdocs.akamai.com/edgeworkers/docs/test-site-failove.md) - [EdgeWorkers CLI](https://techdocs.akamai.com/edgeworkers/docs/akamai-cli.md) - [Create a subWorker](https://techdocs.akamai.com/edgeworkers/docs/create-a-subworker.md) - [Fragment generation using subWorkers](https://techdocs.akamai.com/edgeworkers/docs/subworkers-tutorial.md) - [Flexible composition](https://techdocs.akamai.com/edgeworkers/docs/flexible-composition.md) - [Terminology](https://techdocs.akamai.com/edgeworkers/docs/terminology.md) - [Create a parent EdgeWorker](https://techdocs.akamai.com/edgeworkers/docs/create-a-parent-edgeworker.md) - [Add a child EdgeWorker to an existing parent](https://techdocs.akamai.com/edgeworkers/docs/add-child-edgeworkers.md) - [Review a dynamic reactivation](https://techdocs.akamai.com/edgeworkers/docs/dynamic-reactivation.md) - [Import a static revision](https://techdocs.akamai.com/edgeworkers/docs/review-a-static-activation.md) - [Pin a revision](https://techdocs.akamai.com/edgeworkers/docs/pin-a-revision.md) - [Debug](https://techdocs.akamai.com/edgeworkers/docs/debug-flexible-composition.md) - [Write your JavaScript code](https://techdocs.akamai.com/edgeworkers/docs/write-your-javascript-code.md) - [JavaScript error handling](https://techdocs.akamai.com/edgeworkers/docs/javascript-error-handling.md) - [Create a code bundle](https://techdocs.akamai.com/edgeworkers/docs/create-a-code-bundle.md) - [Code bundle format](https://techdocs.akamai.com/edgeworkers/docs/code-bundle-format.md) - [Import a JavaScript module](https://techdocs.akamai.com/edgeworkers/docs/import-a-javascript-module.md) - [Developer tools](https://techdocs.akamai.com/edgeworkers/docs/developer-tools.md) - [Code bundle editor](https://techdocs.akamai.com/edgeworkers/docs/code-bundle-editor.md) - [TypeScript](https://techdocs.akamai.com/edgeworkers/docs/typescript.md) - [Unit testing for EdgeWorkers](https://techdocs.akamai.com/edgeworkers/docs/unit-testing-for-edgeworkers.md) - [EdgeWorkers IDE extensions (VSCode and IntelliJ)](https://techdocs.akamai.com/edgeworkers/docs/ide-extensions.md) - [Sandbox](https://techdocs.akamai.com/edgeworkers/docs/sandbox.md) - [EdgeWorkers Code Profiler](https://techdocs.akamai.com/edgeworkers/docs/edgeworkers-code-profiler.md) - [Code profiler tutorial](https://techdocs.akamai.com/edgeworkers/docs/code-profiler-tutorial.md) - [Development environment tutorial](https://techdocs.akamai.com/edgeworkers/docs/dev-environment-tutorial.md) - [About the JavaScript API](https://techdocs.akamai.com/edgeworkers/docs/about-the-javascript-api.md) - [Request Object](https://techdocs.akamai.com/edgeworkers/docs/request-object.md) - [User Location Object](https://techdocs.akamai.com/edgeworkers/docs/user-location-object.md) - [Device Object](https://techdocs.akamai.com/edgeworkers/docs/device-object.md) - [CacheKey Object](https://techdocs.akamai.com/edgeworkers/docs/cachekey-object.md) - [BotScore Object](https://techdocs.akamai.com/edgeworkers/docs/botscore-object.md) - [Response Object](https://techdocs.akamai.com/edgeworkers/docs/response-object.md) - [Built-in modules](https://techdocs.akamai.com/edgeworkers/docs/built-in-modules.md) - [create-response](https://techdocs.akamai.com/edgeworkers/docs/create-response.md) - [streams](https://techdocs.akamai.com/edgeworkers/docs/streams.md) - [text-encode-transform](https://techdocs.akamai.com/edgeworkers/docs/text-encode-transform.md) - [http-request](https://techdocs.akamai.com/edgeworkers/docs/http-request.md) - [cookies](https://techdocs.akamai.com/edgeworkers/docs/cookies.md) - [url-search-params](https://techdocs.akamai.com/edgeworkers/docs/url-search-params.md) - [log](https://techdocs.akamai.com/edgeworkers/docs/log.md) - [encoding](https://techdocs.akamai.com/edgeworkers/docs/encoding.md) - [crypto](https://techdocs.akamai.com/edgeworkers/docs/crypto.md) - [html-rewriter](https://techdocs.akamai.com/edgeworkers/docs/htmlrewriter.md) - [External modules](https://techdocs.akamai.com/edgeworkers/docs/external-modules.md) - [HLS parser](https://techdocs.akamai.com/edgeworkers/docs/hls-parser.md) - [DASH parser](https://techdocs.akamai.com/edgeworkers/docs/dash-parser.md) - [jwt](https://techdocs.akamai.com/edgeworkers/docs/jwt.md) - [cwt](https://techdocs.akamai.com/edgeworkers/docs/cwt.md) - [watermarking](https://techdocs.akamai.com/edgeworkers/docs/watermarking.md) - [common access token](https://techdocs.akamai.com/edgeworkers/docs/cat.md) - [Best practices](https://techdocs.akamai.com/edgeworkers/docs/best-practices.md) - [Performance](https://techdocs.akamai.com/edgeworkers/docs/best-practices-for-performance.md) - [Asynchronous processing](https://techdocs.akamai.com/edgeworkers/docs/best-practices-for-asynchronous-processing.md) - [FAQ](https://techdocs.akamai.com/edgeworkers/docs/faq-1.md) - [General questions](https://techdocs.akamai.com/edgeworkers/docs/faq.md) - [Prerequisites and limitations](https://techdocs.akamai.com/edgeworkers/docs/prerequisites-and-limitations.md) - [Technical](https://techdocs.akamai.com/edgeworkers/docs/technical.md) - [EdgeWorkers JavaScript code](https://techdocs.akamai.com/edgeworkers/docs/edgeworkers-javascript-code.md) - [Reporting and billing](https://techdocs.akamai.com/edgeworkers/docs/reporting-and-billing.md) - [Product interoperability](https://techdocs.akamai.com/edgeworkers/docs/product-interoperability.md) - [Troubleshooting](https://techdocs.akamai.com/edgeworkers/docs/troubleshooting.md) - [Content transformation](https://techdocs.akamai.com/edgeworkers/docs/content-transformation.md) - [About JavaScript troubleshooting](https://techdocs.akamai.com/edgeworkers/docs/about-javacript-troubleshooting.md) - [Standard debug headers](https://techdocs.akamai.com/edgeworkers/docs/enable-standard-debug-headers.md) - [Standard debug header details](https://techdocs.akamai.com/edgeworkers/docs/standard-debug-header-details.md) - [Enhanced debug headers](https://techdocs.akamai.com/edgeworkers/docs/enable-enhanced-debug-headers.md) - [Enhanced debug headers for responseProvider](https://techdocs.akamai.com/edgeworkers/docs/enable-enhanced-debug-headers-for-responseprovider.md) - [Enhanced debug header details](https://techdocs.akamai.com/edgeworkers/docs/enhanced-debug-header-details.md) - [Enhanced debug header details for HTTP sub-requests](https://techdocs.akamai.com/edgeworkers/docs/enhanced-debug-header-details-for-http-sub-requests.md) - [Enhanced debug header details for subWorkers](https://techdocs.akamai.com/edgeworkers/docs/enhanced-debug-header-details-for-http-subworkers.md) - [Error codes - EdgeWorkers Management Application](https://techdocs.akamai.com/edgeworkers/docs/error-codes.md) - [Common errors](https://techdocs.akamai.com/edgeworkers/docs/common-errors.md) - [About monitoring](https://techdocs.akamai.com/edgeworkers/docs/about-monitoring.md) - [EdgeWorkers reports](https://techdocs.akamai.com/edgeworkers/docs/manage-report-data.md) - [Overview report](https://techdocs.akamai.com/edgeworkers/docs/overview-report.md) - [Execution status report](https://techdocs.akamai.com/edgeworkers/docs/execution-status-report.md) - [CPU time report](https://techdocs.akamai.com/edgeworkers/docs/execution-time-report.md) - [Memory usage report](https://techdocs.akamai.com/edgeworkers/docs/memory-usage-report.md) - [mPulse reports](https://techdocs.akamai.com/edgeworkers/docs/mpulse.md) - [JavaScript logging](https://techdocs.akamai.com/edgeworkers/docs/enable-javascript-logging.md) - [Use DataStream 2 to deliver JavaScript logs](https://techdocs.akamai.com/edgeworkers/docs/ds2-javascript-logging.md) - [JavaScript Logging details](https://techdocs.akamai.com/edgeworkers/docs/javascript-logging-details.md) - [DataStream 2 logs](https://techdocs.akamai.com/edgeworkers/docs/datastream-2-integration.md) - [DataStream 2 delivery log details](https://techdocs.akamai.com/edgeworkers/docs/datastream2-reports.md) - [Log Delivery Service](https://techdocs.akamai.com/edgeworkers/docs/enable-log-delivery-for-edgeworkers.md) - [Product limits](https://techdocs.akamai.com/edgeworkers/docs/limitations.md) - [Resource tier limitations](https://techdocs.akamai.com/edgeworkers/docs/resource-tier-limitations.md) - [Known issues](https://techdocs.akamai.com/edgeworkers/docs/known-issues.md) ## API Reference - [EdgeWorkers API](https://techdocs.akamai.com/edgeworkers/reference/api.md) - [API summary](https://techdocs.akamai.com/edgeworkers/reference/api-summary.md) - [Get started](https://techdocs.akamai.com/edgeworkers/reference/api-get-started.md) - [EdgeWorkers concepts](https://techdocs.akamai.com/edgeworkers/reference/edgeworker-concepts.md) - [Rate and resource limiting](https://techdocs.akamai.com/edgeworkers/reference/resource-limiting.md) - [Errors](https://techdocs.akamai.com/edgeworkers/reference/api-errors.md) - [Validation types](https://techdocs.akamai.com/edgeworkers/reference/validation-types.md) - [400](https://techdocs.akamai.com/edgeworkers/reference/400.md) - [401](https://techdocs.akamai.com/edgeworkers/reference/401.md) - [403](https://techdocs.akamai.com/edgeworkers/reference/403.md) - [404](https://techdocs.akamai.com/edgeworkers/reference/404.md) - [422](https://techdocs.akamai.com/edgeworkers/reference/422.md) - [429](https://techdocs.akamai.com/edgeworkers/reference/429.md) - [500](https://techdocs.akamai.com/edgeworkers/reference/500.md) - [501](https://techdocs.akamai.com/edgeworkers/reference/501.md) - [502](https://techdocs.akamai.com/edgeworkers/reference/502.md) - [503](https://techdocs.akamai.com/edgeworkers/reference/503.md) - [List permission groups](https://techdocs.akamai.com/edgeworkers/reference/get-groups.md): View a list of groups and the associated permission capabilities, for example: activate a version or fetch an EdgeWorker ID. - [Get a permission group](https://techdocs.akamai.com/edgeworkers/reference/get-group.md): View details on the capabilities enabled within a specified group, for example: activate a version or fetch an EdgeWorker ID. - [List resource tiers](https://techdocs.akamai.com/edgeworkers/reference/get-resource-tiers.md): View the list of available resource tiers for a specific contract ID. The resource tier defines the resource consumption limits for an EdgeWorker ID. - [Create a new EdgeWorker ID](https://techdocs.akamai.com/edgeworkers/reference/post-ids.md): Register a new EdgeWorker ID within a particular group. - [List EdgeWorker IDs](https://techdocs.akamai.com/edgeworkers/reference/get-ids.md): View a list of EdgeWorker IDs created for your account. You can choose to specify the group and resource tier in the request to filter the response. - [Get an EdgeWorker ID](https://techdocs.akamai.com/edgeworkers/reference/get-id.md): View details for a specific EdgeWorker. - [Update an EdgeWorker ID](https://techdocs.akamai.com/edgeworkers/reference/put-id.md): Update the `name` or `groupId` of an existing EdgeWorker. - [Delete an EdgeWorker ID](https://techdocs.akamai.com/edgeworkers/reference/delete-id.md): Delete a specific EdgeWorker ID. - [Clone an EdgeWorker ID](https://techdocs.akamai.com/edgeworkers/reference/post-id-clone.md): Clone an EdgeWorker ID to change the resource tier. - [Get the resource tier](https://techdocs.akamai.com/edgeworkers/reference/get-id-resource-tier.md): View the details of the resource tier assigned to the EdgeWorker ID. - [Create a new version](https://techdocs.akamai.com/edgeworkers/reference/post-versions.md): Create a new version of an EdgeWorker. In order to run this operation you need to build an [EdgeWorkers code bundle](doc:create-a-code-bundle) and save it in GZIP format. You need to provide the GZIP binary file in the request body, with a `Content-Type` of `application/gzip`. - [List versions](https://techdocs.akamai.com/edgeworkers/reference/get-versions.md): View a list of EdgeWorker versions. - [Get version details](https://techdocs.akamai.com/edgeworkers/reference/get-version.md): View details for a specific version. - [Delete version](https://techdocs.akamai.com/edgeworkers/reference/delete-version.md): Delete a specific version. You can't re-use a deleted EdgeWorker version. For instructions on how to create a new version, see [Create a code bundle](doc:create-a-code-bundle) in the EdgeWorkers guide. - [Download an EdgeWorkers code bundle](https://techdocs.akamai.com/edgeworkers/reference/get-version-content.md): Download the bundle containing the code the EdgeWorker executes. - [Activate an EdgeWorker version](https://techdocs.akamai.com/edgeworkers/reference/post-activations.md): Activate an existing EdgeWorker version on the Akamai network, either staging or production. - [List activations](https://techdocs.akamai.com/edgeworkers/reference/get-activations.md): View the list of activations for an existing EdgeWorker based on ID. You can choose to specify the version in the request. The response filters the list of activations down by version number. - [Roll back to the previous active EdgeWorker version](https://techdocs.akamai.com/edgeworkers/reference/post-rollback-to-previous-active-version.md): Reactivate the EdgeWorker version that was previously active on the Akamai network, either staging or production. - [Get an activation](https://techdocs.akamai.com/edgeworkers/reference/get-activation.md): View details for a specific activation. - [Cancel an activation](https://techdocs.akamai.com/edgeworkers/reference/delete-activation.md): Cancel an activation. You can cancel any activation whose `status` is still `PRESUBMIT`, `PENDING`, or `IN_PROGRESS`. Once complete, the activation status changes from `CANCELLING` to `CANCELLED`. - [Deactivate an EdgeWorker version](https://techdocs.akamai.com/edgeworkers/reference/post-deactivations.md): Deactivate an existing EdgeWorker version on the Akamai network, either staging or production. - [List deactivations](https://techdocs.akamai.com/edgeworkers/reference/get-deactivations.md): View the list of deactivations for an existing EdgeWorker. You can limit the results to a specific `version`. - [Get a deactivation](https://techdocs.akamai.com/edgeworkers/reference/get-deactivation.md): View details for a specific deactivation. - [List properties](https://techdocs.akamai.com/edgeworkers/reference/get-properties.md): View the list of properties using an existing EdgeWorker ID. You can limit the results to active properties. - [List revisions](https://techdocs.akamai.com/edgeworkers/reference/get-revisions.md): View the list of revisions for an existing EdgeWorker based on ID. You can limit the results to a specific version or activation. To learn more about Flexible Composition, refer to the [EdgeWorkers guide](doc:flexible-composition). - [Activate a fallback revision](https://techdocs.akamai.com/edgeworkers/reference/post-revision-activations.md): Reactivate a previously active revision on Akamai's staging or production network. To learn more about Flexible Composition, refer to the [EdgeWorkers guide](doc:flexible-composition). - [List revision activations](https://techdocs.akamai.com/edgeworkers/reference/get-revision-activations.md): List activations for an existing EdgeWorker revision based on the EdgeWorker's ID. To learn more about Flexible Composition, refer to the [EdgeWorkers guide](doc:flexible-composition). - [Get a revision](https://techdocs.akamai.com/edgeworkers/reference/get-revision.md): View details for a specific revision. To learn more about Flexible Composition, refer to the [EdgeWorkers guide](doc:flexible-composition). - [Get a revision BOM](https://techdocs.akamai.com/edgeworkers/reference/get-revision-bom.md): View the Bill of Materials for a specific revision. To learn more about Flexible Composition, refer to the [EdgeWorkers guide](doc:flexible-composition). - [Compare revisions](https://techdocs.akamai.com/edgeworkers/reference/post-revision-compare.md): View dependency differences between two revisions of the same EdgeWorker activation. To learn more about Flexible Composition, refer to the [EdgeWorkers guide](doc:flexible-composition). - [Download the combined code bundle](https://techdocs.akamai.com/edgeworkers/reference/get-revision-content.md): Download the combined code bundle that contains the code and the dependencies that the EdgeWorker executes. To learn more about Flexible Composition, refer to the [EdgeWorkers guide](doc:flexible-composition). - [Pin an active revision](https://techdocs.akamai.com/edgeworkers/reference/post-revision-pin.md): Disable dynamic activation for an EdgeWorker revision on Akamai's staging or production network. Note that you can't pin a revision unless it has a dependency. To learn more about Flexible Composition, refer to the [EdgeWorkers guide](doc:flexible-composition). - [Unpin an active revision](https://techdocs.akamai.com/edgeworkers/reference/post-revision-unpin.md): Enable dynamic activation for an EdgeWorker revision on Akamai's staging or production network. Note that you can't unpin a revision unless it has a dependency. To learn more about Flexible Composition, refer to the [EdgeWorkers guide](doc:flexible-composition). - [Validate an EdgeWorkers code bundle](https://techdocs.akamai.com/edgeworkers/reference/post-validations.md): Return a list of errors and warnings containing details on how to fix your code bundle. See [Validation types](ref:validation-types). In order to run this operation you need to provide an EdgeWorkers code bundle as a GZIP binary file in the request body, with a `Content-Type` of `application/gzip`. - [List contract IDs](https://techdocs.akamai.com/edgeworkers/reference/get-contracts.md): View the list of contract IDs that you can use to list resource tiers. - [List reports](https://techdocs.akamai.com/edgeworkers/reference/get-reports.md): View a list of available reports. The data in these reports is also available in the [EdgeWorkers Management application](doc:manage-report-data). Note that reports 2 and 4 have been deprecated. - [Get an EdgeWorker report](https://techdocs.akamai.com/edgeworkers/reference/get-report.md): View a report for a set of EdgeWorkers. Note that reports 2 and 4 have been deprecated. - [Create a secure token](https://techdocs.akamai.com/edgeworkers/reference/post-secure-token.md): Generate a JWT authentication token to [enable enhanced debug headers](doc:enable-enhanced-debug-headers) for EdgeWorkers. - [Get a secure token](https://techdocs.akamai.com/edgeworkers/reference/get-secure-token.md): __Deprecated__ Use the [Create a secure token](ref:post-secure-token) operation instead. This returns a generated authentication token, for use with enhanced debug headers for EdgeWorkers. - [Create a new logging override](https://techdocs.akamai.com/edgeworkers/reference/post-override.md): Override the default JavaScript logging level for a specific EdgeWorker ID. By default, the log level for JavaScript logs is `ERROR`. For more information, go to the [Use DataStream 2 to deliver JavaScript logs](doc:ds2-javascript-logging) tutorial. - [List logging overrides](https://techdocs.akamai.com/edgeworkers/reference/get-overrides.md): View a list of logging overrides created for your EdgeWorker ID. For more information, go to the [Use DataStream 2 to deliver JavaScript logs](doc:ds2-javascript-logging) tutorial. - [Get logging override status](https://techdocs.akamai.com/edgeworkers/reference/get-override.md): Get status information about a specific logging override. For more information, go to the [Use DataStream 2 to deliver JavaScript logs](doc:ds2-javascript-logging) tutorial. - [List limits](https://techdocs.akamai.com/edgeworkers/reference/get-limits.md): View the various limits EdgeWorkers imposes on the number of activations, EdgeWorker IDs, and versions you can deploy. ## Recipes - [Activate an EdgeWorker version](https://techdocs.akamai.com/edgeworkers/recipes/activate-an-edgeworker-version.md) - [Add geo and custom data as a cookie](https://techdocs.akamai.com/edgeworkers/recipes/add-geo-and-custom-data-as-a-cookie.md) - [Boost search autocomplete performance](https://techdocs.akamai.com/edgeworkers/recipes/boost-search-autocomplete-performance.md) - [Cancel an activation](https://techdocs.akamai.com/edgeworkers/recipes/cancel-an-activation.md) - [Clone an EdgeWorker ID](https://techdocs.akamai.com/edgeworkers/recipes/clone-an-edgeworker-id.md) - [Create a new EdgeWorker ID](https://techdocs.akamai.com/edgeworkers/recipes/create-a-new-edgeworker-id.md) - [Create a new version](https://techdocs.akamai.com/edgeworkers/recipes/create-a-new-version.md) - [Create a secure token](https://techdocs.akamai.com/edgeworkers/recipes/create-a-secure-token.md) - [Deactivate an EdgeWorker version](https://techdocs.akamai.com/edgeworkers/recipes/deactivate-an-edgeworker-version.md) - [Delete an EdgeWorker ID](https://techdocs.akamai.com/edgeworkers/recipes/delete-an-edgeworker-id.md) - [Delete an EdgeWorker version](https://techdocs.akamai.com/edgeworkers/recipes/delete-an-edgeworker-version.md) - [Display pages based on location](https://techdocs.akamai.com/edgeworkers/recipes/display-pages-based-on-location.md) - [Download an EdgeWorker bundle](https://techdocs.akamai.com/edgeworkers/recipes/download-an-edgeworker-bundle.md) - [Get a deactivation](https://techdocs.akamai.com/edgeworkers/recipes/get-a-deactivation.md) - [Get a permission group](https://techdocs.akamai.com/edgeworkers/recipes/get-a-permission-group.md) - [Get an activation](https://techdocs.akamai.com/edgeworkers/recipes/get-an-activation.md) - [Get an EdgeWorker ID](https://techdocs.akamai.com/edgeworkers/recipes/get-an-edgeworker-id.md) - [Get an EdgeWorker report](https://techdocs.akamai.com/edgeworkers/recipes/get-an-edgeworker-report.md) - [Get the resource tier](https://techdocs.akamai.com/edgeworkers/recipes/get-the-resource-tier.md) - [Get version details](https://techdocs.akamai.com/edgeworkers/recipes/get-version-details.md) - [List activations](https://techdocs.akamai.com/edgeworkers/recipes/list-activations.md) - [List contract IDs](https://techdocs.akamai.com/edgeworkers/recipes/list-contract-ids.md) - [List deactivations](https://techdocs.akamai.com/edgeworkers/recipes/list-deactivations.md) - [List EdgeWorker IDs](https://techdocs.akamai.com/edgeworkers/recipes/list-edgeworker-ids.md) - [List permission groups](https://techdocs.akamai.com/edgeworkers/recipes/list-permission-groups.md) - [List Properties](https://techdocs.akamai.com/edgeworkers/recipes/list-properties.md) - [List reports](https://techdocs.akamai.com/edgeworkers/recipes/list-reports.md) - [List resource tiers](https://techdocs.akamai.com/edgeworkers/recipes/list-resource-tiers.md) - [List versions](https://techdocs.akamai.com/edgeworkers/recipes/list-versions.md) - [Update an EdgeWorker ID](https://techdocs.akamai.com/edgeworkers/recipes/update-an-edgeworker-id.md) - [Validate an EdgeWorkers code bundle](https://techdocs.akamai.com/edgeworkers/recipes/validate-an-edgeworkers-code-bundle.md) ## Changelog - [June 30, 2026 — Limit and reporting updates](https://techdocs.akamai.com/edgeworkers/changelog/june-2026-limit-and-reporting-updates.md) - [Feb 24, 2026 — Improvements to EdgeWorkers reports](https://techdocs.akamai.com/edgeworkers/changelog/feb-24-2006-edgeworkers-reports-improvements.md) - [Dec 5, 2025 — New onBotSegmentAvailable event handler](https://techdocs.akamai.com/edgeworkers/changelog/onbotsegmentavailable-event-handler.md) - [Oct 7, 2025 — Increased max size for response status and headers generated using createReponse()](https://techdocs.akamai.com/edgeworkers/changelog/max-size-response-status-and-headers.md) - [Aug 4, 2025 — Updates to maximum body size limits](https://techdocs.akamai.com/edgeworkers/changelog/limits-max-body-size.md) # Enhanced Content Control Utility API Documentation > The Enhanced Content Control Utility (ECCU) is one of several supported Akamai purge interfaces. Use ECCU to specify the set of files to refresh on the edge network. Specify directories, file extensions, certain types of HTTP request, or response properties to refine the set of content to refresh. For example, you can refresh specific parts of a library or the complete cache repository for many domains. The ECCU only invalidates content. It does not remove content from cache. ## API Reference - [Enhanced Content Control Utility (ECCU) API](https://techdocs.akamai.com/eccu/reference/api.md) - [API summary](https://techdocs.akamai.com/eccu/reference/api-summary.md) - [Get started](https://techdocs.akamai.com/eccu/reference/get-started.md) - [Rate limits](https://techdocs.akamai.com/eccu/reference/rate-limits.md) - [API workflow](https://techdocs.akamai.com/eccu/reference/api-workflow.md) - [Errors](https://techdocs.akamai.com/eccu/reference/errors.md) - [400](https://techdocs.akamai.com/eccu/reference/400-1.md) - [401](https://techdocs.akamai.com/eccu/reference/401.md) - [403](https://techdocs.akamai.com/eccu/reference/403.md) - [404](https://techdocs.akamai.com/eccu/reference/404.md) - [405](https://techdocs.akamai.com/eccu/reference/405.md) - [408](https://techdocs.akamai.com/eccu/reference/408.md) - [415](https://techdocs.akamai.com/eccu/reference/415.md) - [500](https://techdocs.akamai.com/eccu/reference/500.md) - [503](https://techdocs.akamai.com/eccu/reference/503.md) - [List permissions](https://techdocs.akamai.com/eccu/reference/get-permissions.md): Returns the ECCU permissions. If the response's `submitEccuRequest` member is enabled, you can run the [Create an ECCU request](ref:post-request) operation to invalidate content. - [List properties](https://techdocs.akamai.com/eccu/reference/get-properties.md): Returns the digital properties that you can apply ECCU refresh requests to. - [Create an ECCU request](https://techdocs.akamai.com/eccu/reference/post-request.md): Creates a new ECCU refresh request. - [List ECCU requests](https://techdocs.akamai.com/eccu/reference/get-requests.md): Returns a summary of submitted ECCU refresh requests under your account. Use this to view the `status` of all refresh requests. - [Get an ECCU request](https://techdocs.akamai.com/eccu/reference/get-request.md): Returns a submitted refresh request. Run this operation if you want details on the request's `metadata`. Otherwise, you can run [List ECCU requests](ref:get-requests) to check the `status` of all refresh requests. - [Remove an ECCU request](https://techdocs.akamai.com/eccu/reference/delete-request.md): Removes the refresh request from the list of submitted requests only. This operation doesn't stop the refresh request from being processed. ## Recipes - [GET an ECCU request](https://techdocs.akamai.com/eccu/recipes/get-an-eccu-request.md) - [List ECCU requests](https://techdocs.akamai.com/eccu/recipes/list-eccu-requests.md) - [List permissions](https://techdocs.akamai.com/eccu/recipes/list-permissions.md) - [List properties](https://techdocs.akamai.com/eccu/recipes/list-properties.md) - [Remove an ECCU request](https://techdocs.akamai.com/eccu/recipes/remove-an-eccu-request.md) ## Changelog - [Aug 31, 2021 — New Enhanced Content Control Utility API documentation experience](https://techdocs.akamai.com/eccu/changelog/aug-31-2021-new-enhanced-documentation-experience.md) # Enterprise Application Access Documentation > Akamai’s Enterprise Center for Enterprise Application Access (EAA) integrates data path protection, identity access, multifactor authentication, application security, and management visibility and control for applications hosted in data centers and hybrid cloud environments. Using it, the management and control of remote access for employees, contractors, and partners becomes less complex and more secure. This robust tool delivers access to applications without allowing user access to the entire network. Applications are not accessed directly because they are hidden from the Internet and public exposure. A unique dual-cloud architecture closes all inbound firewall ports while providing authenticated end users with access to only their own special applications. ## Guides - [Welcome to Enterprise Application Access](https://techdocs.akamai.com/eaa/docs/welcome-guide.md) - [Features in technical preview, beta, or limited availability](https://techdocs.akamai.com/eaa/docs/features-in-technical-preview-beta-or-limited-availability.md) - [EAA architecture](https://techdocs.akamai.com/eaa/docs/welcome-eaa.md) - [Allowlist for accessing EAA service](https://techdocs.akamai.com/eaa/docs/allowlist-for-accessing-eaa-service.md) - [Introduction](https://techdocs.akamai.com/eaa/docs/get-started-introduction.md) - [Get started with a Bookmark App](https://techdocs.akamai.com/eaa/docs/start-bookmark-app.md) - [Get started with a web application](https://techdocs.akamai.com/eaa/docs/start-web-app.md) - [Get started with a TCP-type client-access application](https://techdocs.akamai.com/eaa/docs/start-tcp-app.md) - [Secure access to HTTP App with Akamai Workforce Protector DLP (Limited Availability)](https://techdocs.akamai.com/eaa/docs/secure-access-to-http-app-with-akamai-workforce-protector-dlp.md) - [Access and manage EAA from Control Center](https://techdocs.akamai.com/eaa/docs/control-center.md) - [Connectors](https://techdocs.akamai.com/eaa/docs/conn.md) - [Install connector in VMware](https://techdocs.akamai.com/eaa/docs/install-conn-vm.md) - [Configure network with connector VM console menu](https://techdocs.akamai.com/eaa/docs/config-networks-console-menu.md) - [Packet Trace Utility](https://techdocs.akamai.com/eaa/docs/packet-trace-utility.md) - [Install connector in OpenStack/KVM](https://techdocs.akamai.com/eaa/docs/install-connector-in-openstack.md) - [Install connector in Microsoft Hyper-V](https://techdocs.akamai.com/eaa/docs/install-connector-in-microsoft-hyper-v.md) - [Install connector in Amazon Web Services](https://techdocs.akamai.com/eaa/docs/install-connector-in-amazon-web-services.md) - [Install connector in Google Cloud Platform (GCP)](https://techdocs.akamai.com/eaa/docs/install-connector-in-google-cloud-platform.md) - [Install connector in Microsoft Azure](https://techdocs.akamai.com/eaa/docs/install-connector-in-microsoft-azure.md) - [Install a Docker-based connector](https://techdocs.akamai.com/eaa/docs/install-a-docker-based-connector.md) - [Containerized EAA connector](https://techdocs.akamai.com/eaa/docs/use-eaa-docker-connectors-with-akamai-cloud.md) - [Install connector for Podman](https://techdocs.akamai.com/eaa/docs/install-connector-for-podman.md) - [Security update for connectors](https://techdocs.akamai.com/eaa/docs/security-update-for-connectors.md) - [Configure connectors for high availability](https://techdocs.akamai.com/eaa/docs/config-connector-for-high-availability.md) - [Connector upgrade to Ubuntu 22.04 LTS](https://techdocs.akamai.com/eaa/docs/connector-upgrade-to-ubuntu-2204-lts.md) - [Directories](https://techdocs.akamai.com/eaa/docs/dirs.md) - [Cloud Directory](https://techdocs.akamai.com/eaa/docs/cloud-directory.md) - [AD, LDAP, or AD-LDS Directory](https://techdocs.akamai.com/eaa/docs/ad-ldap-or-ad-lds-directory.md) - [Manage user attributes](https://techdocs.akamai.com/eaa/docs/user-attributes.md) - [Advanced Settings for AD, LDAP, AD-LDS directories](https://techdocs.akamai.com/eaa/docs/advanced-settings-for-ad-ldap-ad-lds-directories.md) - [Directory Versioning](https://techdocs.akamai.com/eaa/docs/directory-versioning.md) - [Provision users with SCIM](https://techdocs.akamai.com/eaa/docs/scim-prov.md) - [SCIM provisioning with Azure](https://techdocs.akamai.com/eaa/docs/scim-provisioning-with-azure.md) - [SCIM provisioning with Okta](https://techdocs.akamai.com/eaa/docs/scim-provisioning-with-okta.md) - [Generic SCIM provisioning](https://techdocs.akamai.com/eaa/docs/generic-scim-provisioning-with-onelogin.md) - [Identity and identity providers (IdPs)](https://techdocs.akamai.com/eaa/docs/id-idps.md) - [Basic configuration of an IdP](https://techdocs.akamai.com/eaa/docs/add-new-idp.md) - [Advanced settings of an IdP](https://techdocs.akamai.com/eaa/docs/config-idp.md) - [Embed login portal in IFRAMEs](https://techdocs.akamai.com/eaa/docs/enable-iframe-embedding.md) - [Temporary lockout on IdP and unlock on Cloud Directory](https://techdocs.akamai.com/eaa/docs/temporary-lockout-on-idp-and-unlock-on-cloud-directory.md) - [Self-service password reset for Active Directory Users](https://techdocs.akamai.com/eaa/docs/self-service-password-reset-for-active-directory-users.md) - [Identity provider Session settings](https://techdocs.akamai.com/eaa/docs/identity-provider-session-settings.md) - [Identity Provider Versioning](https://techdocs.akamai.com/eaa/docs/identity-provider-versioning.md) - [SAML](https://techdocs.akamai.com/eaa/docs/saml.md) - [SAML flows](https://techdocs.akamai.com/eaa/docs/saml-flows.md) - [Use EAA as a SAML IdP](https://techdocs.akamai.com/eaa/docs/eaa-saml-idp.md) - [Configure SAML for an access application](https://techdocs.akamai.com/eaa/docs/configure-saml-for-an-access-app.md) - [Configure EAA as an IdP for a custom SaaS application](https://techdocs.akamai.com/eaa/docs/configure-eaa-as-an-idp-for-a-custom-saas-application.md) - [Use Microsoft enhanced client or proxy (ECP) with EAA](https://techdocs.akamai.com/eaa/docs/use-microsoft-enhanced-client-or-proxy-ecp-with-eaa.md) - [SAML Logout for third-party SAML IdP](https://techdocs.akamai.com/eaa/docs/saml-logout-for-third-party-saml-idp.md) - [OpenID Connect](https://techdocs.akamai.com/eaa/docs/configure-openid-connect.md) - [OpenID Connect concepts and terminology](https://techdocs.akamai.com/eaa/docs/openid-connect-concepts-terms.md) - [Configure OpenID Connect for applications](https://techdocs.akamai.com/eaa/docs/config-openid.md) - [Web Services Federation](https://techdocs.akamai.com/eaa/docs/web-services-federation.md) - [Manage user access to applications](https://techdocs.akamai.com/eaa/docs/block-users-accessing-apps.md) - [Use EAA as service provider (SP)](https://techdocs.akamai.com/eaa/docs/use-idp-eaa-service-provider.md) - [Integrate Azure Active Directory](https://techdocs.akamai.com/eaa/docs/integrate-azure-active-dir.md) - [Integrate Active Directory Federation Service (AD FS)](https://techdocs.akamai.com/eaa/docs/integrate-active-dir-ad-fs.md) - [Integrate Okta](https://techdocs.akamai.com/eaa/docs/integrate-okta.md) - [Authenticate access to applications with OneLogin](https://techdocs.akamai.com/eaa/docs/auth-user-access-apps-onelogin.md) - [SSO with other applications](https://techdocs.akamai.com/eaa/docs/sso-auth.md) - [SSO for Jenkins using HTTP headers](https://techdocs.akamai.com/eaa/docs/config-sso-jenkins-use-http-headers.md) - [Desktop single sign-on authentication](https://techdocs.akamai.com/eaa/docs/desktop-single-sign-auth.md) - [Multifactor authentication](https://techdocs.akamai.com/eaa/docs/multi-factor-auth.md) - [PCI DSS compliant MFA](https://techdocs.akamai.com/eaa/docs/pci-dss-mfa.md) - [Use Google Authenticator for TOTP on end-user's device](https://techdocs.akamai.com/eaa/docs/use-google-authenticator-for-setting-up-totp-on-end-users-device.md) - [Use Akamai MFA](https://techdocs.akamai.com/eaa/docs/use-akamai-mfa.md) - [Use DUO MFA](https://techdocs.akamai.com/eaa/docs/use-duo-mfa.md) - [DUO Universal Prompt Support](https://techdocs.akamai.com/eaa/docs/duo-universal-prompt-support.md) - [Use recovery code instead of MFA](https://techdocs.akamai.com/eaa/docs/more-mfa-opt.md) - [Add organization name for SMS and email MFA notifications](https://techdocs.akamai.com/eaa/docs/add-organization-name-for-sms-and-email-mfa-notifications.md) - [Configure end-user's device to receive MFA tokens](https://techdocs.akamai.com/eaa/docs/end-user-configuration-for-mfa-tokens.md) - [Bypass MFA](https://techdocs.akamai.com/eaa/docs/bypass-mfa.md) - [MFA for third-party Identity provider](https://techdocs.akamai.com/eaa/docs/mfa-for-third-party-identity-provider.md) - [Use certificates for authentication](https://techdocs.akamai.com/eaa/docs/certs-eaa.md) - [Certificate-based authentication in the IdP](https://techdocs.akamai.com/eaa/docs/cert-based-auth-idp.md) - [Online certificate status protocol (OCSP)](https://techdocs.akamai.com/eaa/docs/online-cert-status-protocol-ocsp.md) - [Remove a self-signed certificate](https://techdocs.akamai.com/eaa/docs/rm-self-signed-cert.md) - [Certificate rotation of expired certificates](https://techdocs.akamai.com/eaa/docs/certificate-rotation-of-expired-certificates.md) - [Certificate-based device authentication or user validation in an application](https://techdocs.akamai.com/eaa/docs/certificate-based-device-authentication-or-user-validation-in-an-application.md) - [Certificate-based validation of origin servers](https://techdocs.akamai.com/eaa/docs/origin-server.md) - [Network Zones](https://techdocs.akamai.com/eaa/docs/network-zones.md) - [Applications](https://techdocs.akamai.com/eaa/docs/apps.md) - [Configure and deploy an access application](https://techdocs.akamai.com/eaa/docs/add-app-eaa.md) - [Set up CNAME redirect for an application](https://techdocs.akamai.com/eaa/docs/cname-redirect-app.md) - [Authorize access to applications](https://techdocs.akamai.com/eaa/docs/auth-access-apps.md) - [Access applications from EAA Login Portal](https://techdocs.akamai.com/eaa/docs/log-access-apps.md) - [Application config versioning and rollback](https://techdocs.akamai.com/eaa/docs/application-config-versioning-and-rollback.md) - [Single Host Access for access applications](https://techdocs.akamai.com/eaa/docs/single-host-access-for-access-applications.md) - [Application groups for rewrite rules](https://techdocs.akamai.com/eaa/docs/application-groups-for-rewrite-rules.md) - [Offload web application traffic from EAA Cloud](https://techdocs.akamai.com/eaa/docs/offload-web-application-traffic-from-eaa-cloud.md) - [Migrate Applications to new Cloud Zone](https://techdocs.akamai.com/eaa/docs/migrate-applications-to-new-cloud-zone.md) - [Configure application category](https://techdocs.akamai.com/eaa/docs/configure-application-category.md) - [Remote desktop protocol (RDP) applications](https://techdocs.akamai.com/eaa/docs/remote-desktop-protocol-apps.md) - [Create an RDP application](https://techdocs.akamai.com/eaa/docs/remote-desktop-rdp-app.md) - [Configure RDP client display settings](https://techdocs.akamai.com/eaa/docs/rdp-client-display.md) - [Enable SSO login for RDP applications](https://techdocs.akamai.com/eaa/docs/single-sign-auto-login-rdp-apps.md) - [Store files in RDP portal](https://techdocs.akamai.com/eaa/docs/store-rdp.md) - [Modern RDP end-user experience](https://techdocs.akamai.com/eaa/docs/modern-rdp-end-user-experience.md) - [Remote Desktop User Preferences](https://techdocs.akamai.com/eaa/docs/remote-desktop-user-preferences.md) - [SSH applications](https://techdocs.akamai.com/eaa/docs/ssh-apps.md) - [Edge Transport based Tunnel Applications ](https://techdocs.akamai.com/eaa/docs/edge-transport-based-tunnel-applications.md) - [Using Direct Connect with Edge Transport-based Tunnel Applications (Beta)](https://techdocs.akamai.com/eaa/docs/using-direct-connect-with-edge-transport-based-tunnel-applications-beta.md) - [Hybrid Tunnel Applications ](https://techdocs.akamai.com/eaa/docs/hybrid-tunnel-application.md) - [Add access control rules](https://techdocs.akamai.com/eaa/docs/access-control-rules.md) - [Set up services for an application](https://techdocs.akamai.com/eaa/docs/setup-services-app.md) - [Set up advanced settings for an application](https://techdocs.akamai.com/eaa/docs/setup-advanced-settings-app.md) - [User-facing authentication mechanism for applications](https://techdocs.akamai.com/eaa/docs/user-facing-authentication-mechanism-for-applications.md) - [Configure TLS Cipher Suite for applications](https://techdocs.akamai.com/eaa/docs/config-tls-cipher-suite-apps.md) - [Server load balancing for applications](https://techdocs.akamai.com/eaa/docs/server-load-balancing-for-applications-and-connectors.md) - [Kerberos-constrained delegation](https://techdocs.akamai.com/eaa/docs/kerberos-constrained-delegation.md) - [Configure custom HTTP headers](https://techdocs.akamai.com/eaa/docs/custom-http-headers.md) - [EAA Bridging capability](https://techdocs.akamai.com/eaa/docs/eaa-bridging-capability.md) - [SAML to SAML Bridging](https://techdocs.akamai.com/eaa/docs/saml-to-saml-bridging.md) - [Clone Applications](https://techdocs.akamai.com/eaa/docs/clone-applications.md) - [Connector Pools](https://techdocs.akamai.com/eaa/docs/connector-pools.md) - [Unified Connectors](https://techdocs.akamai.com/eaa/docs/unified-connectors.md) - [Unified Connector Migration](https://techdocs.akamai.com/eaa/docs/unified-connector-migration.md) - [Application Access Groups (AAG)](https://techdocs.akamai.com/eaa/docs/application-access-groups.md) - [Customize your organization's Login Portal](https://techdocs.akamai.com/eaa/docs/login-portal-custom.md) - [Set logos, images and themes](https://techdocs.akamai.com/eaa/docs/set-logos-images-and-themes.md) - [Login Portal languages](https://techdocs.akamai.com/eaa/docs/login-portal-lan.md) - [Login Portal Client Download options](https://techdocs.akamai.com/eaa/docs/customize-between-azt-client-and-eaa-client-and-download-urls.md) - [Login portal tab name](https://techdocs.akamai.com/eaa/docs/login-portal-tab-name.md) - [Customize URLs, labels, and recovery code message](https://techdocs.akamai.com/eaa/docs/customize-url-new-user.md) - [Customize EAA Access Denied Page](https://techdocs.akamai.com/eaa/docs/customize-logout-and-authorization-failures.md) - [Customize EAA Logout Page](https://techdocs.akamai.com/eaa/docs/customize-eaa-logout-page.md) - [Customize Footers for Login Portal page](https://techdocs.akamai.com/eaa/docs/customize-footers-for-login-portal-page.md) - [Create favorite applications](https://techdocs.akamai.com/eaa/docs/create-favorite-apps.md) - [Set up MFA to receive tokens on the end-users device](https://techdocs.akamai.com/eaa/docs/set-up-mfa-to-receive-tokens-on-end-the-users-device.md) - [View EAA dashboard](https://techdocs.akamai.com/eaa/docs/view-dashboard.md) - [Reports](https://techdocs.akamai.com/eaa/docs/reports.md) - [Create a report](https://techdocs.akamai.com/eaa/docs/preset-client-rpt.md) - [Download saved report](https://techdocs.akamai.com/eaa/docs/save-download-report.md) - [Real-time Connector Metrics using Datadog, TrafficPeak, and Amazon CloudWatch SIEM providers](https://techdocs.akamai.com/eaa/docs/real-time-connector-metrics-using-siem-providers.md) - [Real-time Connector Metrics using Splunk SIEM provider](https://techdocs.akamai.com/eaa/docs/real-time-connector-metrics-using-splunk-siem-provider.md) - [Send Access Logs to Datadog,TrafficPeak, Splunk, and Amazon CloudWatch SIEM](https://techdocs.akamai.com/eaa/docs/send-access-logs-to-datadog-trafficpeak-splunk-and-amazon-cloudwatch-siem.md) - [Use EAA logs with SIEM, API, or Unified Log Streamer (ULS)](https://techdocs.akamai.com/eaa/docs/use-eaa-logs-with-siem-api-or-unified-log-streamer-uls.md) - [About EAA Client](https://techdocs.akamai.com/eaa/docs/eaa-client-admin.md) - [Use EAA client with TCP and UDP applications](https://techdocs.akamai.com/eaa/docs/qualified-tcp-udp-apps.md) - [Client-access applications](https://techdocs.akamai.com/eaa/docs/client-access-apps.md) - [Tunnel-type 2.0 client-access application](https://techdocs.akamai.com/eaa/docs/tunnel-type-2-0-client-access-app.md) - [EAA Client requirements](https://techdocs.akamai.com/eaa/docs/eaa-client-req.md) - [Set up and use EAA Client](https://techdocs.akamai.com/eaa/docs/deploy-eaa-client.md) - [Configure EAA Client](https://techdocs.akamai.com/eaa/docs/config-eaa-client.md) - [Silent install of EAA Client](https://techdocs.akamai.com/eaa/docs/silent-install-of-eaa-client.md) - [Uninstall EAA Client](https://techdocs.akamai.com/eaa/docs/uninstall-eaa-client.md) - [Customize the download URL for EAA Client](https://techdocs.akamai.com/eaa/docs/customize-the-download-url-for-eaa-client.md) - [Create UDP and TCP applications](https://techdocs.akamai.com/eaa/docs/install-eaa-client-udp-tcp.md) - [View EAA Client reports, user, and application statistics](https://techdocs.akamai.com/eaa/docs/view-app-stats.md) - [EAA Client contextual menu, icons and network states](https://techdocs.akamai.com/eaa/docs/use-eaa-client.md) - [EAA Client basic operations](https://techdocs.akamai.com/eaa/docs/eaa-client-op.md) - [EAA Client run and installation logs](https://techdocs.akamai.com/eaa/docs/eaa-client-run-and-installation-logs.md) - [Introduction](https://techdocs.akamai.com/eaa/docs/eaa-client-ubuntu-introduction.md) - [Set up and use EAA Client for Ubuntu desktop](https://techdocs.akamai.com/eaa/docs/set-up-and-use-eaa-client.md) - [Configure EAA Client (Ubuntu)](https://techdocs.akamai.com/eaa/docs/configure-eaa-client-for-ubuntu.md) - [Configure EAA Client with a forward proxy (Ubuntu)](https://techdocs.akamai.com/eaa/docs/configure-eaa-client-ubuntu-with-a-forward-proxy.md) - [Silent install of EAA Client (Ubuntu)](https://techdocs.akamai.com/eaa/docs/silent-install-of-eaa-client-1.md) - [Uninstall EAA Client (Ubuntu)](https://techdocs.akamai.com/eaa/docs/uninstall-eaa-client-1.md) - [EAA Client run logs (Ubuntu)](https://techdocs.akamai.com/eaa/docs/eaa-client-run-logs.md) - [Limitations for Device Posture support](https://techdocs.akamai.com/eaa/docs/limitations-for-device-posture-support.md) - [Enable captive portal support](https://techdocs.akamai.com/eaa/docs/captive-portal-support.md) - [Enable on-premises detection](https://techdocs.akamai.com/eaa/docs/network-detection.md) - [Access DNS applications with Service Discovery](https://techdocs.akamai.com/eaa/docs/access-dns-apps.md) - [Switch EAA Client to a different IdP](https://techdocs.akamai.com/eaa/docs/switch-id-provider.md) - [Set up services for applications](https://techdocs.akamai.com/eaa/docs/setup-services-apps.md) - [Set up DNS exceptions](https://techdocs.akamai.com/eaa/docs/setup-dns-exceptions.md) - [Support for third-party IdPs](https://techdocs.akamai.com/eaa/docs/support-3p-id-providers.md) - [Forward proxy support](https://techdocs.akamai.com/eaa/docs/forward-proxy-support.md) - [About Device Posture](https://techdocs.akamai.com/eaa/docs/about-dp.md) - [Set up Device Posture](https://techdocs.akamai.com/eaa/docs/setup-dp.md) - [Define risk assessment criteria](https://techdocs.akamai.com/eaa/docs/device-risk-assessments.md) - [Configure tiers and tags](https://techdocs.akamai.com/eaa/docs/tiers-tags.md) - [Define device risk tiers](https://techdocs.akamai.com/eaa/docs/define-device-risk-tiers.md) - [Define device risk tags](https://techdocs.akamai.com/eaa/docs/define-device-risk-tags.md) - [Define versions](https://techdocs.akamai.com/eaa/docs/define-versions.md) - [Configure Device Posture profiles](https://techdocs.akamai.com/eaa/docs/dp-profiles.md) - [Configure Device Posture integrations](https://techdocs.akamai.com/eaa/docs/dp-integrations.md) - [Collect signals from SIA integration](https://techdocs.akamai.com/eaa/docs/signals-integration.md) - [Device Posture ACL Rules](https://techdocs.akamai.com/eaa/docs/device-posture-acl-rules.md) - [Device Posture Remediation Page](https://techdocs.akamai.com/eaa/docs/device-posture-remediation-page.md) - [Review Device Posture dashboard](https://techdocs.akamai.com/eaa/docs/dp-dashboard.md) - [Monitor Device Posture reports](https://techdocs.akamai.com/eaa/docs/monitor-dp-reports.md) - [Create Device Posture report](https://techdocs.akamai.com/eaa/docs/create-dp-report.md) - [Download saved report](https://techdocs.akamai.com/eaa/docs/download-dp-report.md) - [Monitor Device Posture information on desktop devices](https://techdocs.akamai.com/eaa/docs/end-user-clients.md) - [Device Posture for mobile devices](https://techdocs.akamai.com/eaa/docs/device-posture-for-mobile-devices.md) - [Tips for improving performance with EAA](https://techdocs.akamai.com/eaa/docs/tips-and-tricks-for-getting-the-best-performance-with-eaa.md) - [EAA Status Page](https://techdocs.akamai.com/eaa/docs/eaa-status-page.md) - [User Diagnostics portal](https://techdocs.akamai.com/eaa/docs/user-diagnostics-portal.md) - [Troubleshoot EAA](https://techdocs.akamai.com/eaa/docs/trbl.md) - [Application response codes, login events, and errors](https://techdocs.akamai.com/eaa/docs/app-response-codes-login-events-err.md) - [Set up help desk email](https://techdocs.akamai.com/eaa/docs/setup-help-desk-email.md) - [Enable service/debug mode](https://techdocs.akamai.com/eaa/docs/enable-service-debug.md) - [Get Tenant Email Notifications](https://techdocs.akamai.com/eaa/docs/get-tenant-email-notifications.md) - [Troubleshoot connectors](https://techdocs.akamai.com/eaa/docs/trbl-conn.md) - [Troubleshoot directories](https://techdocs.akamai.com/eaa/docs/trbl-dirs.md) - [Troubleshoot IdPs](https://techdocs.akamai.com/eaa/docs/trbl-id-providers.md) - [Troubleshoot applications](https://techdocs.akamai.com/eaa/docs/trbl-apps.md) - [Troubleshoot certificates](https://techdocs.akamai.com/eaa/docs/trbl-certificates.md) - [Troubleshoot reports](https://techdocs.akamai.com/eaa/docs/troubleshoot-reports.md) - [Troubleshoot IWA](https://techdocs.akamai.com/eaa/docs/trbl-iwa.md) - [Troubleshoot EAA Client](https://techdocs.akamai.com/eaa/docs/trbl-eaa-client.md) - [Troubleshoot Device Posture](https://techdocs.akamai.com/eaa/docs/trbl-dp.md) - [Contact support](https://techdocs.akamai.com/eaa/docs/contact-support.md) - [Edge Transport based Web (HTTPs) Application (Beta)](https://techdocs.akamai.com/eaa/docs/edge-transport-based-web-https-application.md) ## Changelog - [July 16, 2026 - Enterprise Application Access Updates](https://techdocs.akamai.com/eaa/changelog/july-16-2026-enterprise-application-access-updates.md) - [June 20, 2026 - Enterprise Application Access Updates](https://techdocs.akamai.com/eaa/changelog/june-20-2026-enterprise-application-access-updates.md) - [April 10, 2026 - Enterprise Application Access Updates](https://techdocs.akamai.com/eaa/changelog/april-10-2026-enterprise-application-access-updates.md) - [February 25, 2026 — Enterprise Application Access Updates](https://techdocs.akamai.com/eaa/changelog/february-25-2026-enterprise-application-access-updates.md) - [January 1, 2026 — Enterprise Application Access Updates](https://techdocs.akamai.com/eaa/changelog/january-1-2026-enterprise-application-access-updates.md) # Firewall Rules Documentation > Firewall Rules lets you manage who receives notifications about Akamai IP address changes. You can subscribe users to specific service notifications, retrieve subscription and service information, and list all CIDR blocks for services you are subscribed to. ## Guides - [Welcome to Firewall Rules Notification](https://techdocs.akamai.com/firewall-rules/docs/welcome-firewall-change-notifications.md) - [About CIDR blocks](https://techdocs.akamai.com/firewall-rules/docs/about-cidr-blocks.md) - [Export CIDR blocks](https://techdocs.akamai.com/firewall-rules/docs/export-cidr-blocks.md) - [Subscribe to notifications](https://techdocs.akamai.com/firewall-rules/docs/subscribe-to-notifications.md) - [Unsubscribe from notifications](https://techdocs.akamai.com/firewall-rules/docs/unsubscribe-from-notifications.md) - [Admin view](https://techdocs.akamai.com/firewall-rules/docs/admin-view.md) ## API Reference - [Firewall Rules Notification API](https://techdocs.akamai.com/firewall-rules/reference/api.md) - [Get started](https://techdocs.akamai.com/firewall-rules/reference/api-get-started.md) - [Rate limits](https://techdocs.akamai.com/firewall-rules/reference/rate-limiting.md) - [Concepts](https://techdocs.akamai.com/firewall-rules/reference/concepts.md) - [Errors](https://techdocs.akamai.com/firewall-rules/reference/api-errors.md) - [400](https://techdocs.akamai.com/firewall-rules/reference/400.md) - [401](https://techdocs.akamai.com/firewall-rules/reference/401.md) - [403](https://techdocs.akamai.com/firewall-rules/reference/403.md) - [404](https://techdocs.akamai.com/firewall-rules/reference/404.md) - [405](https://techdocs.akamai.com/firewall-rules/reference/405.md) - [415](https://techdocs.akamai.com/firewall-rules/reference/415.md) - [500](https://techdocs.akamai.com/firewall-rules/reference/500.md) - [502](https://techdocs.akamai.com/firewall-rules/reference/502.md) - [503](https://techdocs.akamai.com/firewall-rules/reference/503.md) - [List CIDR blocks](https://techdocs.akamai.com/firewall-rules/reference/get-cidr-blocks.md): List all CIDR blocks for all services you are subscribed to. To see additional CIDR blocks, subscribe yourself to more services and run this operation again. - [List services](https://techdocs.akamai.com/firewall-rules/reference/get-services.md): Get a list of services you are subscribed to. To see additional services, subscribe to them first and run the operation again. - [Get a service](https://techdocs.akamai.com/firewall-rules/reference/get-service.md): Get information about a specific service. - [List subscriptions](https://techdocs.akamai.com/firewall-rules/reference/get-subscriptions.md): List subscriptions you created for yourself and other users. You can only see the subscription information for configurations you created yourself. If someone else subscribed you to a service, you won't see that subscription returned by this operation. - [Add or remove subscriptions](https://techdocs.akamai.com/firewall-rules/reference/patch-subscriptions.md): Subscribe or unsubscribe users to services. - [Update subscriptions](https://techdocs.akamai.com/firewall-rules/reference/put-subscriptions.md): Subscribe or unsubscribe users to services. ## Recipes - [Get a service](https://techdocs.akamai.com/firewall-rules/recipes/get-a-service.md) - [List CIDR blocks](https://techdocs.akamai.com/firewall-rules/recipes/list-cidr-blocks.md) - [List services](https://techdocs.akamai.com/firewall-rules/recipes/list-services.md) - [List subscriptions](https://techdocs.akamai.com/firewall-rules/recipes/list-subscriptions.md) - [Update subscriptions](https://techdocs.akamai.com/firewall-rules/recipes/update-subscriptions.md) ## Changelog - [March 22, 2023 — Firewall Rules update](https://techdocs.akamai.com/firewall-rules/changelog/march-23-2021-firewall-change-notifications-update.md) - [Sep 3, 2021 — New Firewall Rules documentation experience](https://techdocs.akamai.com/firewall-rules/changelog/sep-3-2021-new-firewall-rules-documentation-experience.md) - [Oct 20, 2020 — Application and API Enhancements](https://techdocs.akamai.com/firewall-rules/changelog/firewall-rules-notification-enhancements.md) - [May 1, 2017 — Application and API updates](https://techdocs.akamai.com/firewall-rules/changelog/firewall-rules-notification-application-enhancements.md) # Get Started Documentation > The Akamai Control Center's wizard walks you through a basic setup of your product, including creating certificates and other resources you may need to serve content on our network. ## Guides - [Get started with Akamai's content delivery solutions](https://techdocs.akamai.com/start/docs/get-started-akamai.md) - [Which products Control Center's guided wizard supports](https://techdocs.akamai.com/start/docs/products-cc-s-guided-wizard-supports.md) - [How Akamai content delivery works](https://techdocs.akamai.com/start/docs/how-akamai-works.md) - [Edge hostnames](https://techdocs.akamai.com/start/docs/edge-hn.md) - [Content Provider codes](https://techdocs.akamai.com/start/docs/content-provider-code.md) - [Groups](https://techdocs.akamai.com/start/docs/grp.md) - [Properties](https://techdocs.akamai.com/start/docs/prop.md) - [Ion](https://techdocs.akamai.com/start/docs/setup-ion.md) - [Dynamic Site Accelerator](https://techdocs.akamai.com/start/docs/setup-dynamic-site-accelerator.md) - [Rich Media Accelerator](https://techdocs.akamai.com/start/docs/setup-rich-media-accelerator.md) - [Dynamic Site Delivery](https://techdocs.akamai.com/start/docs/setup-dynamic-site-delivery.md) - [Web Application Protector and App &API Protector](https://techdocs.akamai.com/start/docs/web-app-protector.md) - [Add Web Application Protector or App & API Protector to a new hostname](https://techdocs.akamai.com/start/docs/add-web-app-protector-new-hn.md) - [Add Web Application Protector or App & API Protector to an existing delivery product](https://techdocs.akamai.com/start/docs/setup-web-app-protector.md) - [Web Application Protector or App & API Protector with Ion](https://techdocs.akamai.com/start/docs/setup-web-app-protector-ion.md) - [Web Application Protector or App & API Protector with Dynamic Site Accelerator](https://techdocs.akamai.com/start/docs/setup-web-app-protector-dynamic-site-accelerator.md) - [Image and Video Manager](https://techdocs.akamai.com/start/docs/media.md) - [Set Up Image and Video Manager with Ion](https://techdocs.akamai.com/start/docs/ivm-with-ion.md) - [Set Up Image and Video Manager with Dynamic Site Accelerator](https://techdocs.akamai.com/start/docs/ivm-with-dsa.md) - [Activate your settings](https://techdocs.akamai.com/start/docs/activate-settings.md) - [Review and test your site](https://techdocs.akamai.com/start/docs/review-test-site.md) - [Check your computer points to an edge server](https://techdocs.akamai.com/start/docs/check-computer-points-edge-server.md) - [Go live](https://techdocs.akamai.com/start/docs/go-live.md) - [Origin server](https://techdocs.akamai.com/start/docs/origin-server.md) - [Use a cloud provider as your origin](https://techdocs.akamai.com/start/docs/use-cloud-provider-origin.md) - [Edge certificates](https://techdocs.akamai.com/start/docs/edge-certs.md) - [Use an existing certificate or create a new one](https://techdocs.akamai.com/start/docs/use-existing-cert-create-new-one.md) - [Caching](https://techdocs.akamai.com/start/docs/caching.md) - [mPulse](https://techdocs.akamai.com/start/docs/mpulse.md) - [Adaptive Acceleration](https://techdocs.akamai.com/start/docs/adaptive-accel.md) - [SureRoute](https://techdocs.akamai.com/start/docs/sureroute.md) - [Web Application Protector/App & API Protector](https://techdocs.akamai.com/start/docs/web-application-protector-2.md) - [Fine-tune settings after you've activated](https://techdocs.akamai.com/start/docs/fine-tune-settings-after-youve-activated.md) # Get to Know Akamai Documentation > Introduction to the underlying technologies that make up the Akamai Intelligent Edge Platform. ## Guides - [Get to Know Akamai](https://techdocs.akamai.com/platform-basics/docs/welcome.md) - [Akamai's distributed cloud platform](https://techdocs.akamai.com/platform-basics/docs/dist-platform.md) - [Cloud computing](https://techdocs.akamai.com/platform-basics/docs/cloud-compute.md) - [Security](https://techdocs.akamai.com/platform-basics/docs/security.md) - [Content delivery](https://techdocs.akamai.com/platform-basics/docs/content-delivery.md) - [For developers](https://techdocs.akamai.com/platform-basics/docs/for-devs.md) - [Next steps](https://techdocs.akamai.com/platform-basics/docs/next-steps.md) # Global Traffic Management Documentation > Akamai's Global Traffic Management (GTM) helps Internet users access your website or IP applications with greater reliability. It applies an Internet-centric approach to global load balancing to increase site availability and responsiveness to online user requests. Unlike traditional hardware-based solutions that reside within data centers, the fault-tolerant Global Traffic Management service makes intelligent routing decisions. These are based on real-time data center performance health and on global Internet conditions. They transport user requests to the appropriate data center based on the best Internet route for that user at that moment. ## Guides - [Welcome to Global Traffic Management](https://techdocs.akamai.com/gtm/docs/welcome-to-global-traffic-management.md) - [How it works](https://techdocs.akamai.com/gtm/docs/how-it-works.md) - [Understand GTM concepts](https://techdocs.akamai.com/gtm/docs/gtm-concepts.md) - [Property types and contract availability](https://techdocs.akamai.com/gtm/docs/property-types-and-contract-availability.md) - [Access control and scope-based permissions](https://techdocs.akamai.com/gtm/docs/scope-based-permissions.md) - [Firewall rules and liveness tests](https://techdocs.akamai.com/gtm/docs/firewall-rules.md) - [Property type descriptions](https://techdocs.akamai.com/gtm/docs/property-type-descriptions.md) - [Load balancing](https://techdocs.akamai.com/gtm/docs/load-balancing.md) - [Performance with load feedback](https://techdocs.akamai.com/gtm/docs/perf-load-feedback.md) - [Load feedback resources](https://techdocs.akamai.com/gtm/docs/load-feedback-resources.md) - [Resource attributes](https://techdocs.akamai.com/gtm/docs/resource-attributes.md) - [Load object formats](https://techdocs.akamai.com/gtm/docs/load-object-formats.md) - [Download score based load balancing (deprecated)](https://techdocs.akamai.com/gtm/docs/dl-score-load-balancing.md) - [Performance without load feedback](https://techdocs.akamai.com/gtm/docs/perf-without-load-feedback.md) - [Property configuration examples](https://techdocs.akamai.com/gtm/docs/prop-config-x.md) - [Manage GTM service](https://techdocs.akamai.com/gtm/docs/manage-gtm-service.md) - [Workflow to configure the GTM system](https://techdocs.akamai.com/gtm/docs/config-gtm-system.md) - [Manage GTM domains](https://techdocs.akamai.com/gtm/docs/traffic-mgmt-domains.md) - [Manage properties](https://techdocs.akamai.com/gtm/docs/manage-properties.md) - [Add property](https://techdocs.akamai.com/gtm/docs/add-property.md) - [Manage ghost load feedback](https://techdocs.akamai.com/gtm/docs/manage-ghost-load-feedback.md) - [Manage maps](https://techdocs.akamai.com/gtm/docs/manage-maps.md) - [Add traffic targets to property](https://techdocs.akamai.com/gtm/docs/traffic-tgt.md) - [Manage data centers](https://techdocs.akamai.com/gtm/docs/managing-data-centers.md) - [Manage liveness tests](https://techdocs.akamai.com/gtm/docs/managing-liveness-tests.md) - [Manage static record sets](https://techdocs.akamai.com/gtm/docs/manage-static-record-sets.md) - [Manage resources](https://techdocs.akamai.com/gtm/docs/manage-resources.md) - [Manage SSL client certificates](https://techdocs.akamai.com/gtm/docs/manage-ssl-client-certs.md) - [Configure GTM cloud-based services](https://techdocs.akamai.com/gtm/docs/config-gtm-cloud-services.md) - [Review change list detail](https://techdocs.akamai.com/gtm/docs/review-change-list-detail.md) - [View traffic distribution targets](https://techdocs.akamai.com/gtm/docs/view-traffic-distribution.md) - [Work with GTM alerts](https://techdocs.akamai.com/gtm/docs/work-gtm-alerts.md) - [Work with GTM reports](https://techdocs.akamai.com/gtm/docs/work-with-gtm-reports.md) - [Work with Edge Diagnostics](https://techdocs.akamai.com/gtm/docs/work-tm-diagnostic-tools.md) - [Work with DataStream 2](https://techdocs.akamai.com/gtm/docs/use-of-datastream-2.md) ## API Reference - [Global Traffic Management API](https://techdocs.akamai.com/gtm/reference/api.md) - [API summary](https://techdocs.akamai.com/gtm/reference/api-summary.md) - [Get started](https://techdocs.akamai.com/gtm/reference/get-started.md) - [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts.md) - [API workflow](https://techdocs.akamai.com/gtm/reference/api-workflow.md) - [Data conventions](https://techdocs.akamai.com/gtm/reference/data-conventions.md) - [Object versioning](https://techdocs.akamai.com/gtm/reference/api-versioning.md) - [Domain object](https://techdocs.akamai.com/gtm/reference/domain-object.md) - [Property object](https://techdocs.akamai.com/gtm/reference/property-object.md) - [Datacenter object](https://techdocs.akamai.com/gtm/reference/datacenter-object.md) - [API hypermedia](https://techdocs.akamai.com/gtm/reference/api-hypermedia.md) - [Errors](https://techdocs.akamai.com/gtm/reference/api-errors.md) - [400](https://techdocs.akamai.com/gtm/reference/400.md) - [401](https://techdocs.akamai.com/gtm/reference/401.md) - [403](https://techdocs.akamai.com/gtm/reference/403.md) - [404](https://techdocs.akamai.com/gtm/reference/404.md) - [405](https://techdocs.akamai.com/gtm/reference/405.md) - [406](https://techdocs.akamai.com/gtm/reference/406.md) - [409](https://techdocs.akamai.com/gtm/reference/409.md) - [415](https://techdocs.akamai.com/gtm/reference/415.md) - [500](https://techdocs.akamai.com/gtm/reference/500.md) - [Best practices interacting with GTM API](https://techdocs.akamai.com/gtm/reference/best-practices-interacting-with-gtm-api.md) - [Datacenter](https://techdocs.akamai.com/gtm/reference/datacenters-versions.md) - [Domain](https://techdocs.akamai.com/gtm/reference/domain-versions.md) - [Domain summary](https://techdocs.akamai.com/gtm/reference/domain-summary.md) - [Property](https://techdocs.akamai.com/gtm/reference/property.md) - [Liveness test](https://techdocs.akamai.com/gtm/reference/liveness-test.md) - [Traffic target](https://techdocs.akamai.com/gtm/reference/traffic-target.md) - [Get identity](https://techdocs.akamai.com/gtm/reference/get-identity.md): This operation returns information about the API client. Run this operation for details on the API client contract such as available load balancing `features` and `permissions` the client has on the domains tied to the contract. - [List contracts](https://techdocs.akamai.com/gtm/reference/get-identity-contracts.md): This operation returns a list of API client `contracts`. When you [Create a domain](ref:post-domain), you may need a `contractId` under certain circumstances. Run this operation to view available values. - [List groups](https://techdocs.akamai.com/gtm/reference/get-identity-groups.md): This operation returns a list of API client `groups` and their parameters. When you [Create a domain](ref:post-domain), you may need a `groupId` under certain circumstances. Run this operation to view available values. - [Create a domain](https://techdocs.akamai.com/gtm/reference/post-domain.md): Creates a new GTM domain. - [List domains](https://techdocs.akamai.com/gtm/reference/get-domains.md): Returns a list of GTM domain summaries under your contract. - [Get a domain](https://techdocs.akamai.com/gtm/reference/get-domain.md): Returns information for a specific GTM domain. - [Update a domain](https://techdocs.akamai.com/gtm/reference/put-domain.md): Updates a specific GTM domain. - [List domain history](https://techdocs.akamai.com/gtm/reference/get-domain-history.md): Returns a list of each change made to the domain. - [Get domain authorities](https://techdocs.akamai.com/gtm/reference/get-domain-authorities.md): Returns authorities for a specific GTM domain if it is a custom domain and not hosted on config-gtm. - [Submit a bulk domain delete request](https://techdocs.akamai.com/gtm/reference/post-domain-delete-requests.md): Submits an asynchronous request to delete one or more GTM domains. Poll the returned `requestId` using the status endpoint to track progress. - [Get delete request status](https://techdocs.akamai.com/gtm/reference/get-domain-delete-request.md): Returns the current status of a bulk domain delete request, including how many domains have been successfully deleted, failed, and whether processing is complete. - [Get delete request result](https://techdocs.akamai.com/gtm/reference/get-domain-delete-request-result.md): Returns the final result of a completed bulk domain delete request, listing which domains were successfully deleted and which failed. Only available once `isComplete` is `true` in the status endpoint. - [Get domain features](https://techdocs.akamai.com/gtm/reference/get-domain-features.md): Returns the contract features available for a specific GTM domain, including the set of supported property types and security features such as DNSSEC. - [Get a domain summary](https://techdocs.akamai.com/gtm/reference/get-domain-summary.md): Returns summary information for a specific GTM domain, including its activation state, last modification details, and DNSSEC configuration. - [List resources](https://techdocs.akamai.com/gtm/reference/get-resources.md): Returns a list of resources created within the domain that constrain one or more properties in a data center. - [Get a resource](https://techdocs.akamai.com/gtm/reference/get-resource.md): Returns information for a specific resource. - [Create or update a resource](https://techdocs.akamai.com/gtm/reference/put-resource.md): Run this operation to create or update a resource. - [Remove a resource](https://techdocs.akamai.com/gtm/reference/delete-resource.md): Removes a specific resource. - [List properties](https://techdocs.akamai.com/gtm/reference/get-properties.md): Returns a list of GTM properties. - [Get a property](https://techdocs.akamai.com/gtm/reference/get-property.md): Returns information for a specific GTM property. - [Create or update a property](https://techdocs.akamai.com/gtm/reference/put-property.md): Run this operation to create or update a GTM property. - [Remove a property](https://techdocs.akamai.com/gtm/reference/delete-property.md): Removes a specific GTM property. - [Replace all properties](https://techdocs.akamai.com/gtm/reference/put-properties.md): Replaces the complete set of properties on a domain with those specified in the request body. - [Add or update properties](https://techdocs.akamai.com/gtm/reference/patch-properties.md): Adds or updates properties on a domain without replacing the entire set. Properties not included in the request body are left unchanged. - [List CIDR maps](https://techdocs.akamai.com/gtm/reference/get-cidr-maps.md): Returns a list of CIDR maps. - [Get a CIDR map](https://techdocs.akamai.com/gtm/reference/get-cidr-map.md): Returns information for a specific CIDR map. - [Create or update a CIDR map](https://techdocs.akamai.com/gtm/reference/put-cidr-map.md): Run this operation to create or update a CIDR map. - [Remove a CIDR map](https://techdocs.akamai.com/gtm/reference/delete-cidr-map.md): Removes a specific CIDR map. - [List AS maps](https://techdocs.akamai.com/gtm/reference/get-as-maps.md): Returns a list of AS maps. - [Get an AS map](https://techdocs.akamai.com/gtm/reference/get-as-map.md): Returns information for a specific AS map. - [Create or update an AS map](https://techdocs.akamai.com/gtm/reference/put-as-map.md): Run this operation to create or update an AS map. - [Remove an AS map](https://techdocs.akamai.com/gtm/reference/delete-as-map.md): Removes a specific AS map. - [List geographic maps](https://techdocs.akamai.com/gtm/reference/get-geographic-maps.md): Returns a list of geographic maps. - [Get a geographic map](https://techdocs.akamai.com/gtm/reference/get-geographic-map.md): Returns information for a specific geographic map. - [Create or update a geographic map](https://techdocs.akamai.com/gtm/reference/put-geographic-map.md): Run this operation to create or update a geographic map. - [Remove a geographic map](https://techdocs.akamai.com/gtm/reference/delete-geographic-map.md): Removes a geographic map. - [Create a data center](https://techdocs.akamai.com/gtm/reference/post-datacenter.md): This operation creates a specific data center. - [List data centers](https://techdocs.akamai.com/gtm/reference/get-datacenters.md): This operation returns a list of data centers. - [Create an IPv4 data center for ip-version-selector](https://techdocs.akamai.com/gtm/reference/post-datacenter-for-ipv.md): This operation creates a data center which is solely reserved for use by properties of the IP Version Selector type `qtr`. The data center created by this resource is assigned the `datacenterId` 5401, which is interpreted as the target for `A` record requests. - [Create an IPv6 data center for ip-version-selector](https://techdocs.akamai.com/gtm/reference/post-datacenter-for-ipv6.md): This operation creates a data center which is solely reserved for use by properties of type `qtr` (IP Version Selector). The data center created by this resource is assigned the `datacenterId` 5402, which is interpreted as the target for `AAAA` record requests. - [Create a default data center](https://techdocs.akamai.com/gtm/reference/post-default-datacenter-for-maps.md): This operation creates a data center for use by the map-type properties CIDR, Geographic or AS mapping as the default data center. - [Get a data center](https://techdocs.akamai.com/gtm/reference/get-datacenter.md): This operation returns information for a specific data center. - [Update a data center](https://techdocs.akamai.com/gtm/reference/put-datacenter.md): This operation updates a specific data center. - [Remove a data center](https://techdocs.akamai.com/gtm/reference/delete-datacenter.md): Remove a data center: This operation removes a data center. You can only remove a data center when no properties or resources are assigned to it. - [Get current status](https://techdocs.akamai.com/gtm/reference/get-status-current.md): This operation returns information about the current condition of the change in the domain's activation. - [Get status for a domain version](https://techdocs.akamai.com/gtm/reference/get-status.md): Returns the propagation status for a specific domain version, identified by its `changeId`. - [List Akamai cloud regions](https://techdocs.akamai.com/gtm/reference/get-akamai-cloud-regions.md): This operation returns a list of available Akamai cloud regions. Use these regions when creating a data center with a `cloudProvider` of `akamai-cloud`. Each region includes geographic metadata such as city, country, latitude, and longitude that you can use to populate data center fields. - [List datacenter IDs](https://techdocs.akamai.com/gtm/reference/get-datacenter-ids.md): Returns a paginated list of valid datacenter IDs available for use as virtual datacenters. - [List supported geo codes](https://techdocs.akamai.com/gtm/reference/get-supported-geo-codes.md): Returns the full hierarchy of supported geographic codes — continents, countries, and states or provinces — that you can use when configuring geographic maps. - [List DNS record set types](https://techdocs.akamai.com/gtm/reference/get-recordset-types.md): Returns the DNS record types supported for GTM properties, optionally filtered by domain. ## Changelog - [Mar 25, 2026 — GTM updates](https://techdocs.akamai.com/gtm/changelog/mar-25-2026-gtm-updates.md) - [Jul 23, 2025 — GTM updates](https://techdocs.akamai.com/gtm/changelog/jul-23-2025-gtm-updates.md) - [Jan 23, 2025 — GTM updates](https://techdocs.akamai.com/gtm/changelog/jan-23-2025-gtm-updates.md) - [Jul 01, 2024 — GTM updates](https://techdocs.akamai.com/gtm/changelog/jul-01-2024-gtm-updates.md) - [Jan 03, 2024 — GTM updates](https://techdocs.akamai.com/gtm/changelog/jan-03-2024.md) # GTM Load Feedback API Documentation > Akamai's Global Traffic Management Load Feedback API allows users to submit load data for a GTM domain in either JSON or XML format via POST, and to fetch the current load state via GET. ## API Reference - [Global Traffic Management Load Feedback API](https://techdocs.akamai.com/gtm-load-feedback/reference/global-traffic-management-load-feedback-api.md) - [API summary](https://techdocs.akamai.com/gtm-load-feedback/reference/api-summary.md) - [Get started](https://techdocs.akamai.com/gtm-load-feedback/reference/get-started.md) - [API workflow](https://techdocs.akamai.com/gtm-load-feedback/reference/api-workflow.md) - [Resources](https://techdocs.akamai.com/gtm-load-feedback/reference/resources.md) - [Errors](https://techdocs.akamai.com/gtm-load-feedback/reference/errors.md) - [400](https://techdocs.akamai.com/gtm-load-feedback/reference/400.md) - [403](https://techdocs.akamai.com/gtm-load-feedback/reference/403.md) - [404](https://techdocs.akamai.com/gtm-load-feedback/reference/404.md) - [405](https://techdocs.akamai.com/gtm-load-feedback/reference/405.md) - [429](https://techdocs.akamai.com/gtm-load-feedback/reference/429.md) - [500](https://techdocs.akamai.com/gtm-load-feedback/reference/500.md) - [Submit load data](https://techdocs.akamai.com/gtm-load-feedback/reference/post-domain-resource.md): Use this action to submit load data. The URL specifies the `domain`, `resource`, and `datacenterId` of the instance to which the load data pertains. The data may be submitted in either XML or JSON format. To support legacy clients, we allow `region` as an alias for `datacenterId`. The timestamp string should be in XSD format. - [Get load data](https://techdocs.akamai.com/gtm-load-feedback/reference/get-domain-resource.md): Use this action to fetch the load data for a resource instance. The URL format is the same as the POST action. The API returns either XML or JSON, depending on your `Accept` header. If both are specified, or there is no `Accept` header, the default is JSON. In this sample data, we're fetching load for a resource called `connections` in datacenter 100, in the `example.akadns.net` domain. ## Changelog - [Jan 27, 2022 — New Global Traffic Management Load Feedback API documentation experience](https://techdocs.akamai.com/gtm-load-feedback/changelog/jan-27-2022-new-global-traffic-management-load-feedback-api-documentation-experience.md) # GTM Reporting API Documentation > Akamai's Global Traffic Management Reporting (GTM) API provides read-only reports on GTM’s real time statistics. Each call allows you to view traffic, liveness, direct demand, load feedback, and latency on datacenters and properties. ## API Reference - [Global Traffic Management Reporting API](https://techdocs.akamai.com/gtm-reporting/reference/api.md) - [API summary](https://techdocs.akamai.com/gtm-reporting/reference/api-summary.md) - [Get started](https://techdocs.akamai.com/gtm-reporting/reference/get-started.md) - [API concepts](https://techdocs.akamai.com/gtm-reporting/reference/api-concepts.md) - [Errors](https://techdocs.akamai.com/gtm-reporting/reference/errors.md) - [400](https://techdocs.akamai.com/gtm-reporting/reference/400.md) - [401](https://techdocs.akamai.com/gtm-reporting/reference/401.md) - [403](https://techdocs.akamai.com/gtm-reporting/reference/403.md) - [404](https://techdocs.akamai.com/gtm-reporting/reference/404.md) - [405](https://techdocs.akamai.com/gtm-reporting/reference/405.md) - [Get a domain list](https://techdocs.akamai.com/gtm-reporting/reference/get-domain-list.md): This operation retrieves a list of domains, along with a URL templated link to obtain a domain summary of associated properties and data centers for each. - [Get a domain summary](https://techdocs.akamai.com/gtm-reporting/reference/get-domain-list-domain.md): This operation retrieves a list of property names, as well as Datacenter names and IDs for a given domain. - [List domain names for an account and contract type](https://techdocs.akamai.com/gtm-reporting/reference/get-domain-names-for-account.md): Returns a list of GTM domain names accessible to the current user for the given account and contract type. - [List domain names](https://techdocs.akamai.com/gtm-reporting/reference/get-domain-names.md): Returns a list of GTM domain names accessible to the current user. - [Report directed demand for a property](https://techdocs.akamai.com/gtm-reporting/reference/get-demand-property.md): The requests generated by the client machines behind a client name-server represent demand. This API returns a collection of reports containing the provisioned demand percentage, along with actual demand percentage seen by GTM rounded off to nearest 5 min interval for each data center. This API returns no data for load feedback-based domains, as those domains do not have a configured per data center load. - [Get a directed demand report window](https://techdocs.akamai.com/gtm-reporting/reference/get-demand-window.md): Returns the date range of data available for directed demand reports. Use the returned `start` and `end` values as the bounds for queries to the directed demand report endpoint. - [List IP availability per property](https://techdocs.akamai.com/gtm-reporting/reference/get-ip-availability-property.md): GTM combines scores (based on Liveness Tests) from all Web agents to calculate Server Scores and makes liveness decisions. A cutoff value is computed for each property from the median scores for all the servers in the property. Any property server with a score over the cutoff value is considered dead and it won't be handed out. The request should have either start and end time or mostRecent, and not both. In the response, `handedOut` in JSON or `handOut` in CSV indicates whether the server was handed out and alive indicates whether GTM considered the server as alive or not. - [Report latency per data center](https://techdocs.akamai.com/gtm-reporting/reference/get-latency-datacenter.md): This operation returns a collection of reports representing latency and loss of ping data as reported by network agents in each Data Center for a property. Latency and Loss parameters follow bucket ranges schema (bucket ranges, delimited by a pipe: `|`). Ping Loss ranges from `0%` to `100%`. So a schema of `5|10|15|20` would represent grouping of data from `0%` to `5%`, `5%` to `10%`, `10%` to `15%`, `15%` to `20%`, and `20%` to `100%` bucket ranges. The end of one bucket would be the beginning of the next bucket. Similarly `0|5|80` would represent `0%`, `0%` to `5%`, `5%` to `100%`, and `80%` to `100%` bucket ranges. A trailing pipe at the end of a bucket indicates that there is no _greater than the max_ bucket. That is, in the above example if loss schema were `0|5|80|` then it would mean `0%`, `0%` to `5%`, and `5%` to `80%`. Latency is measured in milliseconds. Each bucket ranges from 0 ms to 1000 ms. So, a schema of `5|10|300|1000` would mean `0ms` to `5ms`, `5ms` to `10ms`, `10ms` to `300ms`, `300ms` to `1000ms`, and `> 1000ms`. - [Report liveness per property](https://techdocs.akamai.com/gtm-reporting/reference/get-liveness-tests-property.md): This operation returns a collection of reports containing logs of individual liveness tests which have failed. Liveness Tests are run periodically by Web Agents installed in customer data centers. Liveness scores are used by GTM to decide whether a data center is alive or not. Liveness tests which fail in succession (tests that run from the same testing agent to the same origin server, which fail with the same error code) are grouped together and represented with a duration. This duration value is in seconds and can sustain for up to 86400 seconds (one day). If it crosses that boundary, GTM logs it as a new failure at the beginning of the next day (00:00 UTC), with the duration reset to that point. - [List liveness test errors](https://techdocs.akamai.com/gtm-reporting/reference/get-liveness-tests-error-codes.md): This operation lists all the possible liveness test error codes (as displayed on the Liveness Test Failures report) and a description of each error. - [Get a Liveness Test error](https://techdocs.akamai.com/gtm-reporting/reference/get-liveness-tests-error-code.md): This operation returns an error description for the given Liveness Test error ID. - [Get a liveness test report window](https://techdocs.akamai.com/gtm-reporting/reference/get-liveness-tests-window.md): Returns the date range of data available for liveness test reports. Use the returned `start` and `end` values as the bounds for queries to the liveness test report endpoint. - [Report load feedback](https://techdocs.akamai.com/gtm-reporting/reference/get-load-feedback.md): This report shows the historical values of a given Resource across all data centers and the given time period. A resource is anything that can constrain the load sent to a data center. Examples of typical resources include bandwidth, CPU load average, database queries per second, or disk operations per second. - [Get most recent load feedback data](https://techdocs.akamai.com/gtm-reporting/reference/get-most-recent-load-data.md): Returns the most recent load feedback values reported by each data center for the given domain. This provides a snapshot of the current load state across all data centers. - [Get a load feedback report window](https://techdocs.akamai.com/gtm-reporting/reference/get-load-feedback-window.md): Returns the date range of data available for load feedback reports. Use the returned `start` and `end` values as the bounds for queries to the load feedback report endpoint. - [Report traffic per data center](https://techdocs.akamai.com/gtm-reporting/reference/get-traffic-datacenter.md): This report shows, for a given domain and data center, the DNS requests received in each five-minute period. Requests are broken down by property. - [Report traffic per property](https://techdocs.akamai.com/gtm-reporting/reference/get-traffic-property.md): This report shows, for a given domain and property, the DNS requests received in each five-minute period. Requests are broken down by data center. - [Get a datacenter traffic report window](https://techdocs.akamai.com/gtm-reporting/reference/get-traffic-datacenters-window.md): Returns the date range of data available for datacenter traffic reports. Use the returned `start` and `end` values as the bounds for queries to the datacenter traffic report endpoint. - [Get a property traffic report window](https://techdocs.akamai.com/gtm-reporting/reference/get-traffic-properties-window.md): Returns the date range of data available for property traffic reports. Use the returned `start` and `end` values as the bounds for queries to the property traffic report endpoint. - [Report datacenter diagnostics](https://techdocs.akamai.com/gtm-reporting/reference/get-diagnostics-datacenter.md): Returns diagnostic data showing how traffic from autonomous systems and countries is being distributed across datacenters for the given domain and time period. - [Report IP diagnostics](https://techdocs.akamai.com/gtm-reporting/reference/get-diagnostics-ip.md): Returns diagnostic data showing the per-name server mapping decisions made by GTM for the given domain, property, IP address, and time period. Includes scoring details such as latency, ping scores, and which datacenter was selected. - [Report map diff diagnostics](https://techdocs.akamai.com/gtm-reporting/reference/get-diagnostics-mapdiff.md): Returns a diff of traffic distribution map snapshots for the given domain and time period, showing how AS and country-to-datacenter mappings changed between consecutive five-minute intervals. - [Report detailed map diff diagnostics for a data center and AS](https://techdocs.akamai.com/gtm-reporting/reference/get-diagnostics-mapdiff-datacenter-as.md): Returns detailed geo and ping score time series for the given domain, datacenter, and autonomous system over the specified time period. - [Report detailed map diff diagnostics for a data center and country](https://techdocs.akamai.com/gtm-reporting/reference/get-diagnostics-mapdiff-datacenter-country.md): Returns detailed geo and ping score time series for the given domain, datacenter, and country over the specified time period. ## Changelog - [Jan 27, 2022 — New GTM Reporting API documentation experience](https://techdocs.akamai.com/gtm-reporting/changelog/jan-27-2022-new-gtm-reporting-api-documentation-experience.md) # Guardicore Platform Agent Documentation > Guardicore Platform Agent (formerly Zero Trust Client) integrates data path protection, identity access, multi-factor authentication, application security, management visibility, and control for applications hosted in data centers and hybrid cloud environments. Using it, the management and control of remote access for employees, contractors, and partners becomes less complex and more secure. This robust tool delivers access to applications without allowing user access to the entire network. Applications are not accessed directly because they are hidden from the Internet and public exposure. A unique dual-cloud architecture closes all inbound firewall ports while providing authenticated end users with access to only their own special applications. Threat Protection offers a cloud-based, targeted threat protection solution that safeguards your organization from DNS and web-based threats, enforces authentication and acceptable use policies, and audits user Internet access. Segmentation lets you control access, implement security policies, and maintain segmentation throughout your entire environment. ## Guides - [Welcome to Guardicore Platform Agent](https://techdocs.akamai.com/guardicore-platform-agent/docs/welcome.md) - [About Access, Threat Protection, and Segmentation](https://techdocs.akamai.com/guardicore-platform-agent/docs/about-aztc.md) - [Guardicore Platform Agent rollout process](https://techdocs.akamai.com/guardicore-platform-agent/docs/zero-trust-client-rollout-process.md) - [Requirements](https://techdocs.akamai.com/guardicore-platform-agent/docs/requirements.md) - [Prepare for Guardicore Platform Agent setup](https://techdocs.akamai.com/guardicore-platform-agent/docs/prepare-for-ztc-setup.md) - [Forward proxy support](https://techdocs.akamai.com/guardicore-platform-agent/docs/proxy-support.md) - [Set up Threat Protection](https://techdocs.akamai.com/guardicore-platform-agent/docs/set-threat-protection.md) - [Set up Guardicore Platform Agent](https://techdocs.akamai.com/guardicore-platform-agent/docs/install-aztc.md) - [Silent installation](https://techdocs.akamai.com/guardicore-platform-agent/docs/silent-installation.md) - [Access hook scripts](https://techdocs.akamai.com/guardicore-platform-agent/docs/access-hook-scripts.md) - [Configure Guardicore Platform Agent](https://techdocs.akamai.com/guardicore-platform-agent/docs/configure-aztc.md) - [Uninstall Guardicore Platform Agent](https://techdocs.akamai.com/guardicore-platform-agent/docs/uninstall-aztc.md) - [Multiuser support](https://techdocs.akamai.com/guardicore-platform-agent/docs/multi-user-support.md) - [Use Guardicore Platform Agent](https://techdocs.akamai.com/guardicore-platform-agent/docs/use-guardicore-platform-agent.md) - [Change display language](https://techdocs.akamai.com/guardicore-platform-agent/docs/change-display-language.md) - [Agent statuses and notifications](https://techdocs.akamai.com/guardicore-platform-agent/docs/service-status-notifications.md) - [Manage services](https://techdocs.akamai.com/guardicore-platform-agent/docs/manage-services.md) - [Manage authentication](https://techdocs.akamai.com/guardicore-platform-agent/docs/manage-authentication.md) - [Check device posture](https://techdocs.akamai.com/guardicore-platform-agent/docs/check-device-posture.md) - [Manage proxies and networks](https://techdocs.akamai.com/guardicore-platform-agent/docs/manage-proxies-and-networks.md) - [Update Guardicore Platform Agent](https://techdocs.akamai.com/guardicore-platform-agent/docs/update-guardicore-platform-agent.md) - [Manage Guardicore Platform Agent](https://techdocs.akamai.com/guardicore-platform-agent/docs/manage-client-versions.md) - [Configure Threat Protection](https://techdocs.akamai.com/guardicore-platform-agent/docs/configure-threat-protection.md) - [Transparent traffic interception](https://techdocs.akamai.com/guardicore-platform-agent/docs/transparent-traffic-interception.md) - [View Client Inventory](https://techdocs.akamai.com/guardicore-platform-agent/docs/aztc-ec-user-inv.md) - [View device details](https://techdocs.akamai.com/guardicore-platform-agent/docs/view-user-and-device-details.md) - [Guardicore Platform Agent](https://techdocs.akamai.com/guardicore-platform-agent/docs/troubleshoot-akamai-zero-trust-client.md) - [Installation and uninstallation issues](https://techdocs.akamai.com/guardicore-platform-agent/docs/installation-and-uninstallation-issues.md) - [Diagnostics and agent logs](https://techdocs.akamai.com/guardicore-platform-agent/docs/diagnostics-and-agent-logs.md) - [Resolve common issues](https://techdocs.akamai.com/guardicore-platform-agent/docs/resolve-access-threat-protection-segmentation-problems.md) - [Check agent alerts](https://techdocs.akamai.com/guardicore-platform-agent/docs/check-agent-alerts.md) - [Error codes](https://techdocs.akamai.com/guardicore-platform-agent/docs/error-codes.md) - [Collect logs with gpactl](https://techdocs.akamai.com/guardicore-platform-agent/docs/collect-logs-with-gpactl.md) - [Known issues, caveats, and limitations](https://techdocs.akamai.com/guardicore-platform-agent/docs/known-issues-and-limitations.md) ## Changelog - [Jun 23, 2026 — Akamai Guardicore Platform Agent 7.2.3-v52.14 general availability](https://techdocs.akamai.com/guardicore-platform-agent/changelog/akamai-guardicore-platform-agent-723-v5214-general-availability.md) - [Jun 12, 2026 — Akamai Guardicore Platform Agent 7.4.0-v53.5 limited availability](https://techdocs.akamai.com/guardicore-platform-agent/changelog/akamai-guardicore-platform-agent-740-v535-limited-availability.md) - [May 20, 2026 — Akamai Guardicore Platform Agent 7.3.4-v53.4 limited availability](https://techdocs.akamai.com/guardicore-platform-agent/changelog/may-20-2026-akamai-guardicore-platform-agent-734-v534-limited-availability.md) - [Apr 9, 2026 — Akamai Guardicore Platform Agent 7.3.2-v53.2.1 general availability](https://techdocs.akamai.com/guardicore-platform-agent/changelog/akamai-guardicore-platform-agent-732-v5321-general-availability.md) - [Jan 26, 2026 — Akamai Guardicore Platform Agent 7.3.0-v53.0 limited availability](https://techdocs.akamai.com/guardicore-platform-agent/changelog/akamai-guardicore-platform-agent-730-v530-limited-availability.md) # Identity and Access Management API Documentation > The Identity and Access Management API lets account administrators: - Manage and maintain users and their access to ​Akamai Control Center​ applications and resources - Maintain user accounts and other general user information - Manage groups and group access - Create or update roles - Move properties between groups - Filter ​Control Center​ user login requests for the account, using IP Allowlist - Edit their own information and perform other administrative tasks for other users in addition to all tasks regular users perform Additionally, this API lets you manage your API client credentials. API credentials can only be rotated by the client owner. If you're a user or administrator, use this API to manage API access availability and run general operations performed on the Identity and Access Manager user interface from the Settings tab ## API Reference - [Identity and Access Management API v3](https://techdocs.akamai.com/iam-api/reference/api.md) - [API summary](https://techdocs.akamai.com/iam-api/reference/api-summary.md) - [Get started](https://techdocs.akamai.com/iam-api/reference/get-started.md) - [Identity and Access Management concepts](https://techdocs.akamai.com/iam-api/reference/api-concepts.md) - [Rotate credentials](https://techdocs.akamai.com/iam-api/reference/rotate-credentials.md) - [Rate limits](https://techdocs.akamai.com/iam-api/reference/rate-limits.md) - [Manage access to properties and includes](https://techdocs.akamai.com/iam-api/reference/manage-access-to-properties-and-includes.md) - [Identity and Access Management migration](https://techdocs.akamai.com/iam-api/reference/iam-api-migration.md) - [Errors](https://techdocs.akamai.com/iam-api/reference/api-errors.md) - [400](https://techdocs.akamai.com/iam-api/reference/400.md) - [401](https://techdocs.akamai.com/iam-api/reference/401.md) - [403](https://techdocs.akamai.com/iam-api/reference/403.md) - [404](https://techdocs.akamai.com/iam-api/reference/404.md) - [405](https://techdocs.akamai.com/iam-api/reference/405.md) - [415](https://techdocs.akamai.com/iam-api/reference/415.md) - [List groups](https://techdocs.akamai.com/iam-api/reference/get-groups.md): This operation lists all groups the administrator can manage for the current account and contract type or other managed accounts using the `accountSwitchKey` parameter. The account and contract type are determined by the access tokens in your API client. - [Create a new group](https://techdocs.akamai.com/iam-api/reference/post-group.md): This operation creates a new group within the specified parent group. - [Get a group](https://techdocs.akamai.com/iam-api/reference/get-group.md): This operation retrieves a group's details. - [Modify a group's name](https://techdocs.akamai.com/iam-api/reference/put-group.md): This operation changes a group's name. - [Delete a group](https://techdocs.akamai.com/iam-api/reference/delete-group.md): This operation deletes a group. You can't delete a group that contains subgroups, resources, or users with roles on that group. You need admin access to delete a group. - [Move a group](https://techdocs.akamai.com/iam-api/reference/post-groups-move.md): This operation moves a nested group under another group within the same parent hierarchy. - [List users affected by moving a group](https://techdocs.akamai.com/iam-api/reference/get-move-affected-users.md): This operation lists users who are affected when you move a group. Users may lose or gain access to resources depending on the roles and permissions inherited from the new parent group. Users with a `userType` of `lostAccess` lose their access to the source group. If the `userType` is `gainAccess`, they gain access to the resources in the source group. Users who have inherited access to a group lose access to that group if it moves out of its hierarchy that gives them those access rights. If the group moves to another parent group to which they have access, they still have access to the group you move. Likewise, when you move a group to a new location, users who inherit their access rights from the new parent group gain access to the resources in the group you move. - [List properties or includes](https://techdocs.akamai.com/iam-api/reference/get-properties.md): This operation lists the properties and includes for the current account or other managed accounts using the `accountSwitchKey` parameter. Include the `groupId` parameter in your request to filter the results by group. The response returns a list of `propertyId` regardless of whether they represent a property or include in PAPI. To learn more, see [Manage access to properties and includes](ref:manage-access-to-properties-and-includes). - [Get a property or include](https://techdocs.akamai.com/iam-api/reference/get-property.md): This operation fetches a property's or include's details. The response returns details for `propertyId` regardless of whether it represent a property or include in PAPI. To learn more, see [Manage access to properties and includes](ref:manage-access-to-properties-and-includes). - [Move a property or include](https://techdocs.akamai.com/iam-api/reference/put-property.md): This operation moves a property or include from one group to another group. You can only move an asset into another group within the same group hierarchy. Depending on your role in the destination group, you may lose access to resources the asset uses. Before moving an asset, run the [List users affected by moving a group](ref:get-move-affected-users) operation to review which users will be affected by the move. - [List users for property or include](https://techdocs.akamai.com/iam-api/reference/get-property-users.md): This operation lists users who can access a property or include. - [Block users from a property or include](https://techdocs.akamai.com/iam-api/reference/put-property-users-block.md): This operation blocks the users on a property or include. - [Get asset's resources](https://techdocs.akamai.com/iam-api/reference/get-property-resources.md): This operation lists resources a property or include uses to deliver your web content across Akamai's edge network. You can think of these resources as objects, like CP codes and configuration files. For example, an ARL (Akamai resource locator) configuration file specifies how Akamai purges versions of an object that you can’t purge using just the URL. - [Create a role](https://techdocs.akamai.com/iam-api/reference/post-role.md): This operation creates a custom role, which is a combination of [grantable roles](ref:get-grantable-roles). The role that you create becomes available only for your current contract type. To learn more, see [Identity and Access Management concepts](ref:api-concepts). - [List roles](https://techdocs.akamai.com/iam-api/reference/get-roles.md): This operation lists roles for the current account and contract type or other accounts using the `accountSwitchKey` parameter. The account and contract type are determined by the access tokens in your API client. - [Get a role](https://techdocs.akamai.com/iam-api/reference/get-role.md): This operation retrieves a role's details. - [Edit a role](https://techdocs.akamai.com/iam-api/reference/put-role.md): This operation adds or removes a role's group role assignments, along with other data such as name and description. When you modify a role, those changes affect existing API clients. Review all API clients belonging to the user before modifying a role. - [Delete a role](https://techdocs.akamai.com/iam-api/reference/delete-role.md): This operation deletes a custom role. You can't delete a role if it's assigned to a user. - [List grantable roles](https://techdocs.akamai.com/iam-api/reference/get-grantable-roles.md): This operation lists the grantable roles you can include in a new custom role, or add to an existing custom role. - [Create a user](https://techdocs.akamai.com/iam-api/reference/post-ui-identity.md): This operation creates a user, or clones an existing user's role assignments, in the account specified in your API client credentials. Optionally, sends a randomly generated one-time use password to the new user. If you send the email with the password directly to the user, the response for this operation doesn't include that password. If you don't send the password to the user through email, the password is included in the response. - [List users](https://techdocs.akamai.com/iam-api/reference/get-ui-identities.md): This operation lists the users who have access to your current account or other managed accounts using the `accountSwitchKey` parameter. The account is determined by the tokens in your API client. You can pass a `groupId` to filter users based on group. You can also return user information such as what product notifications they subscribe to, or what group and role assignments they have. Set the `actions` parameter to `true` to return the actions you can take on each user. - [Get a user](https://techdocs.akamai.com/iam-api/reference/get-ui-identity.md): This operation retrieves a user's profile. - [Remove a user](https://techdocs.akamai.com/iam-api/reference/delete-ui-identity.md): This operation deletes any user who doesn't own an API client. Before you delete a user with a client, [transfer API client ownership](https://techdocs.akamai.com/iam/docs/transfer-api-client-ownership) to another user. - [Update a user](https://techdocs.akamai.com/iam-api/reference/put-ui-identity-basic-info.md): This operation modifies a user's basic information. Pass the entire body of data in the request, including members you're not changing, or the unspecified data are removed. To edit detailed settings, run the [Modify a user's group and role assignments](ref:put-ui-uiidentity-auth-grants) or [Update a user's notifications](ref:put-notifications) operations. - [List blocked properties and includes](https://techdocs.akamai.com/iam-api/reference/get-blocked-properties.md): This operation lists all properties and includes a user doesn't have access to in a group. Note the responses's set of IDs refer to either properties or includes. To find out which each refers to, see [Manage access to properties and includes](ref:manage-access-to-properties-and-includes). - [Update blocked properties and includes](https://techdocs.akamai.com/iam-api/reference/put-blocked-properties.md): This operation updates the list of blocked properties and includes. By default, users can access all properties and includes in a group, and this operation specifies IDs for any to block. To find out which each refers to, see [Manage access to properties and includes](ref:manage-access-to-properties-and-includes). To get the list of already blocked properties run the [List blocked properties and includes](ref:get-blocked-properties) operation. In this request, include the whole list of properties you want to block. By not including a blocked property, you're unlocking it. - [Lock a user's account](https://techdocs.akamai.com/iam-api/reference/post-ui-identity-lock.md): This operation locks a user's account, preventing access to Control Center. To allow a user access to Control Center, run the [Unlock a user's account](ref:post-ui-identity-unlock) operation. To learn more, see [Temporary account lockout](https://techdocs.akamai.com/iam/docs/tmp-account-lockout). - [Reset a user's password](https://techdocs.akamai.com/iam-api/reference/post-reset-password.md): This operation sends a one-time use password to the user. If you send the email with the password directly to the user, the response for this operation doesn't include that password. If you don't send the password to the user through email, the password is included in the response. - [Set a user's password](https://techdocs.akamai.com/iam-api/reference/post-set-password.md): This operation sets a password for a user. This differs from [Reset a user's password](ref:post-reset-password) because this password may be used more than once, and isn't randomly generated. - [Unlock a user's account](https://techdocs.akamai.com/iam-api/reference/post-ui-identity-unlock.md): This operation releases the lock on a user's account, allowing access to Control Center. To learn more, see [Temporary account lockout](https://techdocs.akamai.com/iam/docs/tmp-account-lockout). - [Set a user's multi-factor authentication](https://techdocs.akamai.com/iam-api/reference/put-ui-identity-additional-authentication.md): This operation sets a user's multi-factor authentication to `TFA`, `MFA`, or `NONE`. Users are allowed five login attempts with MFA or 2FA before their account is locked. If the account is locked, use the [Reset additional authentication](ref:put-ui-identity-reset-additional-authentication) to unlock it. - [Reset a user's multi-factor authentication](https://techdocs.akamai.com/iam-api/reference/put-ui-identity-reset-additional-authentication.md): This operation prompts the reset of a user's multi-factor authentication method the next time they log in to Control Center. `TFA` indicates two-factor authentication. `MFA` indicates Akamai MFA authentication. - [Update a user's notifications](https://techdocs.akamai.com/iam-api/reference/put-notifications.md): This operation subscribes or unsubscribes users to product notification emails. - [Modify a user's group and role assignments](https://techdocs.akamai.com/iam-api/reference/put-ui-uiidentity-auth-grants.md): This operation edits what groups a user has access to, and how the user interacts with the objects in those groups. - [View your profile](https://techdocs.akamai.com/iam-api/reference/get-user-profile.md): This operation gets your profile information. To make changes to your profile, run the [Edit your profile](ref:put-user-profile-info) operation. - [Edit your profile](https://techdocs.akamai.com/iam-api/reference/put-user-profile-info.md): This operation updates your basic profile information, such as your name or phone number. To edit detailed settings, run the [Update your notifications](ref:put-user-profile-notifications) or [Modify a user's group and role assignments](ref:put-ui-uiidentity-auth-grants) operations. - [Set multi-factor authentication for your user profile](https://techdocs.akamai.com/iam-api/reference/put-user-profile-additional-authentication.md): This operation sets multi-factor authentication to `TFA`, `MFA`, or `NONE`. You have five login attempts with MFA or 2FA before your account is locked. If your account is locked, use the [Reset multi-factor authentication for your user profile](ref:put-user-profile-reset-additional-authentication) operation to unlock it. - [Reset multi-factor authentication for your user profile](https://techdocs.akamai.com/iam-api/reference/put-user-profile-reset-additional-authentication.md): This operation resets your multi-factor authentication. - [Rotate your password](https://techdocs.akamai.com/iam-api/reference/post-profile-change-password.md): This operation changes your password. Include your old password and your new password in the request body. Before you create your new password, run the [View password policy](ref:get-common-password-policy) operation to ensure it adheres to your policy. If you include your existing password incorrectly and make too many login attempts, your account locks. - [Update your notifications](https://techdocs.akamai.com/iam-api/reference/put-user-profile-notifications.md): This operation subscribes to notifications emails for password expiration reminders, proactive maintenance emails, and upgrade notification emails. - [View contact types](https://techdocs.akamai.com/iam-api/reference/get-common-contact-types.md): This operation lists the supported contact types. Administrators should use the values from this operation to add or update a user's `contactType`. Users should run the [View contact types for a user profile](ref:get-user-contact-types) operation before modifying their contact type. - [View countries](https://techdocs.akamai.com/iam-api/reference/get-common-countries.md): This operation lists the supported countries. Administrators should use the values from this operation to add or update a user's `country`. Users should run the [View supported countries for a user profile](ref:get-user-countries) operation before modifying their country. - [View states](https://techdocs.akamai.com/iam-api/reference/get-common-states.md): This operation lists the supported U.S. states or Canadian provinces. Administrators should use the values from this operation to add or update a user's `state`. If a user's state or province is unknown, use `TBD`. Users should run the [View states for a user profile](ref:get-user-states) operation before modifying their state. - [View languages](https://techdocs.akamai.com/iam-api/reference/get-common-languages.md): This operation lists the supported languages. Administrators should use the values from this operation to set a user's `preferredLanguage`. Users should run the [View languages for a user profile](ref:get-user-languages) operation before setting their preferred language. - [View time zones](https://techdocs.akamai.com/iam-api/reference/get-common-timezones.md): This operation lists the supported time zones in the ISO 8601 format. Administrators should use the values from this operation to set a user's `timeZone`. Users should run the [View time zones for a user profile](ref:get-user-timezones) operation before setting their time zone. - [View products](https://techdocs.akamai.com/iam-api/reference/get-common-notification-products.md): This operation lists the products a user can subscribe to and receive notifications for on the account. The tokens in your API client determine the account. Administrators should use the values from this operation to set a user's product notifications. Users should run the [View products for a user profile](ref:get-user-notification-products) operation before setting their product notifications. - [View password policy](https://techdocs.akamai.com/iam-api/reference/get-common-password-policy.md): This operation lists the password policy for the account. The tokens in your API client determine the account. Administrators should use the values from this operation to set a user's password policy. Users should run the [View password policy for a user profile](ref:get-user-password-policy) operation before setting their password policy. - [View timeout policies](https://techdocs.akamai.com/iam-api/reference/get-common-timeout-policies.md): This operation returns the supported session timeout policies an administrator can use when [creating](ref:post-ui-identity) and [updating](ref:put-ui-identity-basic-info) user profiles. The `name` for each timeout period is in minutes, and the time `value` is in seconds. Make sure to select a value that's equal or smaller to the **Max session timeout** value, set for your account in the Identity and Access Management interface's [Settings](https://techdocs.akamai.com/iam/docs/account-settings) tab. Users should run the [View timeout policies for a user profile](ref:get-user-timeout-policies) operation before setting their timeout policy. - [View contact types for a user profile](https://techdocs.akamai.com/iam-api/reference/get-user-contact-types.md): This operation lists the supported contact types. Users should use the values from this operation to add or update their `contactType`. Administrators should run the [View contact types](ref:get-common-contact-types) operation before modifying a user's contact type. - [View supported countries for a user profile](https://techdocs.akamai.com/iam-api/reference/get-user-countries.md): This operation lists the supported countries. Users should use the values from this operation to add or update their `country`. Administrators should run the [View supported countries](ref:get-common-countries) operation before modifying a user's country. - [View states for a user profile](https://techdocs.akamai.com/iam-api/reference/get-user-states.md): This operation lists the supported U.S. states or Canadian provinces. Users should use the values from this operation to add or update their `state`. Administrators should run the [View states](ref:get-common-states) operation before modifying a user's state. - [View languages for a user profile](https://techdocs.akamai.com/iam-api/reference/get-user-languages.md): This operation lists the supported languages. Users should use the values from this operation to set their preferred language. Administrators should run the [View languages](ref:get-common-languages) operation before setting a user's preferred language. - [View time zones for a user profile](https://techdocs.akamai.com/iam-api/reference/get-user-timezones.md): This operation lists the supported time zones in the ISO 8601 format. Users should use the values from this operation to set their `timeZone`. Administrators should run the [View time zones](ref:get-common-timezones) operation before setting a user's time zone. - [View products for a user profile](https://techdocs.akamai.com/iam-api/reference/get-user-notification-products.md): This operation lists the products a user can subscribe to and receive notifications for on the account. The account is determined by the tokens in your API client. Users should use the values from this operation to set their product notifications. Administrators should run the [View products](ref:get-common-notification-products) operation before setting a user's product notifications. - [View password policy for a user profile](https://techdocs.akamai.com/iam-api/reference/get-user-password-policy.md): This operation lists the password policy for the account. The account is determined by the tokens in your API client. Users should use the values from this operation to set their password policy. Administrators should run the [View password policy](ref:get-common-password-policy) operation before setting a user's password policy. - [View timeout policies for a user profile](https://techdocs.akamai.com/iam-api/reference/get-user-timeout-policies.md): This operation returns the supported session timeout policies an account user can use when [updating](ref:put-user-profile-info) their profile. The `name` for each timeout period is in minutes, and the time `value` is in seconds. Make sure to select a value that's equal or smaller to the **Max session timeout** value, set for your account in the Identity and Access Management interface's [Settings](https://techdocs.akamai.com/iam/docs/account-settings) tab. Administrators should run the [View timeout policies](ref:get-common-timeout-policies) operation before setting a user's timeout policy. - [Create a CIDR block](https://techdocs.akamai.com/iam-api/reference/post-allowlist.md): This operation adds CIDR blocks to your account's allowlist. You can add only one CIDR block at a time. Before creating the CIDR block, you may want to [validate it](ref:get-allowlist-validate), to check if its format is correct. - [List CIDR blocks](https://techdocs.akamai.com/iam-api/reference/get-allowlist.md): This operation lists all CIDR blocks on your current account's allowlist or other managed accounts using the `accountSwitchKey` parameter. Your API client designates the allowlist for the account. - [Validate CIDR blocks](https://techdocs.akamai.com/iam-api/reference/get-allowlist-validate.md): This operation checks the format of a potential CIDR block. If it's validated successfully, you can [create it](ref:post-allowlist). - [Get a CIDR block](https://techdocs.akamai.com/iam-api/reference/get-allowlist-cidrblockid.md): This operation retrieves a CIDR block's details. - [Modify a CIDR block](https://techdocs.akamai.com/iam-api/reference/put-allowlist-cidrblockid.md): This operation enables or disables an existing CIDR block, updates comments, IP addresses, or ranges in the CIDR block. Note that you can only update a CIDR block with IP allowlist enabled on the account. There are several CIDR blocks on the allowlist and your attempt to make changes to the CIDR block is from an IP address that's on the allowlist. You can't edit the last CIDR block in the allowlist or the CIDR block allowing access to the current user. - [Delete a CIDR block](https://techdocs.akamai.com/iam-api/reference/delete-allowlist-cidrblockid.md): This operation deletes a CIDR block from the IP allowlist. After you delete a CIDR block, any requests from IP addresses you deleted fail the next time someone tries to log in from that address. Users accessing Control Center from an IP address you delete aren't automatically logged out of Control Center at the time you delete the IP address. With IP allowlist enabled for the account, you can't delete the last CIDR block in the allowlist or the CIDR block allowing access to the current user. There are no restrictions with IP allowlist disabled on the account. - [Disable IP allowlist](https://techdocs.akamai.com/iam-api/reference/post-allowlist-disable.md): This operation disables IP allowlist on your account. After you disable IP allowlist, users can access Control Center regardless of their IP address or who assigns it. - [Enable IP allowlist](https://techdocs.akamai.com/iam-api/reference/post-allowlist-enable.md): This operation enables IP allowlist on your account. Before you enable IP allowlist, add at least one IP address to allow access to Control Center. The allowlist can't be empty with IP allowlist enabled. - [View IP allowlist status](https://techdocs.akamai.com/iam-api/reference/get-allowlist-status.md): This operation indicates whether IP allowlist is enabled or disabled on your account. - [List authorized users](https://techdocs.akamai.com/iam-api/reference/get-api-clients-users.md): This operation lists authorized API client users. - [List allowed APIs](https://techdocs.akamai.com/iam-api/reference/get-api-clients-users-allowed-apis.md): This operation lists available APIs for a user. - [List allowed CP codes](https://techdocs.akamai.com/iam-api/reference/post-api-clients-users-allowed-cpcodes.md): This operation lists available CP codes for a user. - [List accessible groups](https://techdocs.akamai.com/iam-api/reference/get-api-clients-users-group-access.md): This operation lists groups available to a user. - [Get your API client](https://techdocs.akamai.com/iam-api/reference/get-api-client-self.md): This operation provides details about your API client. - [Update your API client](https://techdocs.akamai.com/iam-api/reference/put-api-clients-self.md): This operation updates your API client. - [Delete your API client](https://techdocs.akamai.com/iam-api/reference/delete-api-client-self.md): This operation permanently deletes an API client you own, without active credentials. It also breaks any API connections with the client. Before deleting your API client, deactivate all credentials and make sure there aren't any API integrations or scripts using them. - [List your account switch keys](https://techdocs.akamai.com/iam-api/reference/get-self-account-switch-keys.md): This operation lists account switch keys available for your API client. You can use the `accountSwitchKey` in many Akamai APIs [to make an API call to another account](https://techdocs.akamai.com/developer/docs/manage-many-accounts-with-one-api-client). - [Lock your API client](https://techdocs.akamai.com/iam-api/reference/put-lock-api-client-self.md): This operation locks your API client, preventing it from making requests on the network. You can't use the API client while it's locked. To unlock your client, run the [Unlock an API client](ref:put-unlock-api-client) operation. - [Create an API client](https://techdocs.akamai.com/iam-api/reference/post-api-clients.md): This operation creates a new API client. Optionally, you can automatically assign a credential for the client when you create it. If you choose not to assign the credential automatically, see [Create authentication credentials](https://techdocs.akamai.com/developer/docs/set-up-authentication-credentials) for details. This operation doesn't support service accounts. To create or manage API clients for service accounts, you need to use [Identity and Access interface](https://techdocs.akamai.com/iam/docs/create-an-api-client-for-a-service-account). - [List API clients](https://techdocs.akamai.com/iam-api/reference/get-api-clients.md): This operation lists API clients an administrator can manage on the current account or other managed accounts using the `accountSwitchKey` parameter. - [Get an API client](https://techdocs.akamai.com/iam-api/reference/get-api-client.md): This operation provides details about an API client. - [Update an API client](https://techdocs.akamai.com/iam-api/reference/put-api-clients.md): This operation updates an API client. This operation doesn't support service accounts. To create or manage API clients for service accounts, you need to use [Identity and Access interface](https://techdocs.akamai.com/iam/docs/create-an-api-client-for-a-service-account). - [Delete an API client](https://techdocs.akamai.com/iam-api/reference/delete-api-client.md): This operation permanently deletes the API client, breaking any API connections with the client. To delete a client, you need to own the client, or have admin access on a given group. Before deleting an API client, make sure there aren't any API integrations or scripts using it. - [List account switch keys](https://techdocs.akamai.com/iam-api/reference/get-client-account-switch-keys.md): This operation lists account switch keys available for a specific API client. The client can use the `accountSwitchKey` in many Akamai APIs to [make an API call to another account](https://techdocs.akamai.com/developer/docs/manage-many-accounts-with-one-api-client). - [Lock an API client](https://techdocs.akamai.com/iam-api/reference/put-lock-api-client.md): This operation locks an API client, preventing it from making requests on the network. You can't use the API client while it's locked. To unlock a client, run the [Unlock an API client](ref:put-unlock-api-client) operation. - [Unlock an API client](https://techdocs.akamai.com/iam-api/reference/put-unlock-api-client.md): This operation unlocks an API client, allowing it to make requests on the network. - [Create your credential](https://techdocs.akamai.com/iam-api/reference/post-self-credentials.md): This operation creates a new credential for your API client. Only you may create credentials for this client. Credentials are in `active` status at creation. By default, they expire two years from their creation date. However, when the API client's permissions are based on Control Center permissions, credentials expire differently and follow the same rotation schedule listed for user passwords on those accounts. Run the [Update a credential](ref:put-client-credential) operation to change the expiration date, description, or status. Save the values from the response, such as the `credentialID` for future use. This is the only time you'll see the client secret. Save the credential at this time to avoid the need to create a new one. - [List your credentials](https://techdocs.akamai.com/iam-api/reference/get-self-credentials.md): This operation lists your API client's credentials. - [Deactivate your credentials](https://techdocs.akamai.com/iam-api/reference/post-self-credentials-deactivate.md): This operation deactivates all credentials for your API client. This doesn't delete the API client or the credentials. To deactivate a single credential, run either the [Deactivate your credential](ref:post-self-credential-deactivate) operation or [Update your credential](ref:put-self-credential) and set the status to `INACTIVE`. - [Get your credential](https://techdocs.akamai.com/iam-api/reference/get-self-credential.md): This operation provides details about a specific credential for your API client. To change the credential's expiration date or toggle its activation status, run the [Update a credential](ref:put-client-credential) operation. - [Update your credential](https://techdocs.akamai.com/iam-api/reference/put-self-credential.md): This operation updates a specific credential for your API client. You can change the expiration date, description, or toggle the activation status. This isn't the same as rotating a credential. For details, see [Rotate credentials](ref:rotate-credentials). - [Remove your credential](https://techdocs.akamai.com/iam-api/reference/delete-self-credential.md): This operation deletes a specific credential from your API client. You can only delete inactive credentials. - [Deactivate your credential](https://techdocs.akamai.com/iam-api/reference/post-self-credential-deactivate.md): This operation deactivates a specific credential for your API client. This doesn't delete the client or the credentials. To update a specific credential, run the [Update your credential](ref:put-self-credential) operation. - [Create a credential](https://techdocs.akamai.com/iam-api/reference/post-client-credentials.md): This operation creates a new credential for your API client. If you don't know your `clientId`, you can run the [Create your credential](ref:post-self-credentials) operation. Credentials are in `active` status at creation. By default, they expire two years from their creation date. However, when the API client's permissions are based on Control Center permissions, credentials expire differently and follow the same rotation schedule listed for user passwords on those accounts. Run the [Update a credential](ref:put-client-credential) operation to change the expiration date, description, or status. Save the values from the response, such as the `credentialID`, for future use. This is the only time you'll see the client secret. Save the credential to avoid the need to create a new one. - [List credentials](https://techdocs.akamai.com/iam-api/reference/get-client-credentials.md): This operation lists credentials for an API client. - [Deactivate credentials](https://techdocs.akamai.com/iam-api/reference/post-client-credentials-deactivate.md): This operation deactivates all credentials for a specific API client. This doesn't delete the API client or the credentials. To deactivate a single credential, run either the [Deactivate a credential](ref:post-client-credential-deactivate) operation or [Update a credential](ref:put-client-credential) and set the status to `INACTIVE`. - [Get a credential](https://techdocs.akamai.com/iam-api/reference/get-client-credential.md): This operation returns details about a specific credential for an API client. To change the credential's expiration date or toggle its activation status, run the [Update credential for an API client](ref:put-client-credential) operation. - [Update a credential](https://techdocs.akamai.com/iam-api/reference/put-client-credential.md): This operation updates a specific credential for an API client. You can change the expiration date, description, or toggle the activation status. This isn't the same as rotating a credential. For details, see [Rotate credentials](ref:rotate-credentials). - [Remove a credential](https://techdocs.akamai.com/iam-api/reference/delete-client-credential.md): This operation deletes a specific credential from an API client. You can only delete inactive credentials. - [Deactivate a credential](https://techdocs.akamai.com/iam-api/reference/post-client-credential-deactivate.md): This operation deactivates a specific credential for an API client. This doesn't delete the API client, or the other credentials. ## Recipes - [Clone a user](https://techdocs.akamai.com/iam-api/recipes/clone-a-user.md) - [Create a CIDR block](https://techdocs.akamai.com/iam-api/recipes/create-a-cidr-block.md) - [Create a role](https://techdocs.akamai.com/iam-api/recipes/create-a-role.md) - [Create a user](https://techdocs.akamai.com/iam-api/recipes/create-a-user.md) - [Create an API client](https://techdocs.akamai.com/iam-api/recipes/create-an-api-client.md) - [Edit a role](https://techdocs.akamai.com/iam-api/recipes/edit-a-role.md) - [Edit your profile](https://techdocs.akamai.com/iam-api/recipes/edit-your-profile.md) - [List users affected by moving a group](https://techdocs.akamai.com/iam-api/recipes/list-users-affected-by-moving-a-group.md) - [Modify a CIDR block](https://techdocs.akamai.com/iam-api/recipes/modify-a-cidr-block.md) - [Modify a user's group and role assignments](https://techdocs.akamai.com/iam-api/recipes/modify-a-users-group-and-role-assignments.md) - [Move a group](https://techdocs.akamai.com/iam-api/recipes/move-a-group.md) - [Move a property](https://techdocs.akamai.com/iam-api/recipes/move-a-property.md) - [Rotate your password](https://techdocs.akamai.com/iam-api/recipes/rotate-your-password.md) - [Update a credential](https://techdocs.akamai.com/iam-api/recipes/update-a-credential.md) - [Update a user](https://techdocs.akamai.com/iam-api/recipes/update-a-user.md) - [Update a user's notifications](https://techdocs.akamai.com/iam-api/recipes/update-a-users-notifications.md) - [Update an API client](https://techdocs.akamai.com/iam-api/recipes/update-an-api-client.md) - [Update blocked properties](https://techdocs.akamai.com/iam-api/recipes/update-blocked-properties.md) - [Update your API client](https://techdocs.akamai.com/iam-api/recipes/update-your-api-client.md) - [Update your credential](https://techdocs.akamai.com/iam-api/recipes/update-your-credential.md) ## Changelog - [Sept 3, 2024 — Account level roles](https://techdocs.akamai.com/iam-api/changelog/sept-3-2024.md) - [Mar 1, 2024 — API v1 and API v2 Decommission](https://techdocs.akamai.com/iam-api/changelog/mar-1-2024.md) - [Aug 23, 2023 — Single Sign-On Configuration API](https://techdocs.akamai.com/iam-api/changelog/aug-23-2023-single-sign-on-configuration-api.md) - [Jun 15, 2023 — Postman collection available](https://techdocs.akamai.com/iam-api/changelog/jun-15-2023-postman-collection-available.md) - [July 14, 2022 — Identity and Access Management API updates](https://techdocs.akamai.com/iam-api/changelog/july-8-2022-combined-api-services.md) # Image and Video Manager Documentation > With more people using mobile devices and more ways to deliver content, dealing with your images and videos can be challenging. Akamai's Image and Video Manager gives you the control you need to expertly manage them and fully engage your web visitors. ## Guides - [Welcome to Image and Video Manager](https://techdocs.akamai.com/ivm/docs/welcome-ivm.md) - [How it works](https://techdocs.akamai.com/ivm/docs/how-image-and-video-optimization-works.md) - [Prerequisites](https://techdocs.akamai.com/ivm/docs/prerequisites.md) - [Incompatible products and features](https://techdocs.akamai.com/ivm/docs/incompatible-products-features.md) - [Best practices for source files](https://techdocs.akamai.com/ivm/docs/best-practices-for-images-and-videos.md) - [Best practices for pristine images](https://techdocs.akamai.com/ivm/docs/bp-images.md) - [Best practices for pristine videos](https://techdocs.akamai.com/ivm/docs/bp-videos.md) - [Supported image and video formats](https://techdocs.akamai.com/ivm/docs/supported-image-and-video-formats.md) - [Key concepts and terms](https://techdocs.akamai.com/ivm/docs/key-concepts-and-terms.md) - [Free trial guide](https://techdocs.akamai.com/ivm/docs/free-trial-guide.md) - [Hello World tutorial (images)](https://techdocs.akamai.com/ivm/docs/hello-world-images.md) - [Hello World tutorial (videos)](https://techdocs.akamai.com/ivm/docs/hello-world-videos.md) - [Configuration workflow](https://techdocs.akamai.com/ivm/docs/configuration-workflow.md) - [Connect your images and videos](https://techdocs.akamai.com/ivm/docs/connect-images-videos.md) - [Add an Image and Video Manager rule](https://techdocs.akamai.com/ivm/docs/add-ivm-rule.md) - [Add the Image and Video Manager (Images) behavior](https://techdocs.akamai.com/ivm/docs/add-image-behavior.md) - [Add the Image and Video Manager (Videos) behavior](https://techdocs.akamai.com/ivm/docs/add-video-behavior.md) - [Add the Set Parameter behavior](https://techdocs.akamai.com/ivm/docs/add-set-param-behavior.md) - [Improve image selection using Client Hints](https://techdocs.akamai.com/ivm/docs/image-selection-using-client-hints.md) - [Control user access with granular permissions](https://techdocs.akamai.com/ivm/docs/granular-user-permissions.md) - [Create and edit a policy set](https://techdocs.akamai.com/ivm/docs/create-edit-policy-set.md) - [Create and edit policies](https://techdocs.akamai.com/ivm/docs/create-edit-policies.md) - [Test your policy on staging](https://techdocs.akamai.com/ivm/docs/test-on-staging.md) - [Go live on production](https://techdocs.akamai.com/ivm/docs/go-live-on-production.md) - [Create perceptual quality previews](https://techdocs.akamai.com/ivm/docs/perceptual-quality-preview.md) - [Optimize your images](https://techdocs.akamai.com/ivm/docs/optimize-images.md) - [Optimize your videos](https://techdocs.akamai.com/ivm/docs/optimize-videos.md) - [Add image transformations and conditions](https://techdocs.akamai.com/ivm/docs/add-img-transformations.md) - [Apply your policies](https://techdocs.akamai.com/ivm/docs/apply-policy.md) - [Append](https://techdocs.akamai.com/ivm/docs/append.md) - [Aspect Crop](https://techdocs.akamai.com/ivm/docs/aspect-crop.md) - [Background Color](https://techdocs.akamai.com/ivm/docs/background-color.md) - [Blur](https://techdocs.akamai.com/ivm/docs/blur.md) - [Chroma Key](https://techdocs.akamai.com/ivm/docs/chroma-key.md) - [Composite](https://techdocs.akamai.com/ivm/docs/composite.md) - [Contrast](https://techdocs.akamai.com/ivm/docs/contrast.md) - [Crop](https://techdocs.akamai.com/ivm/docs/crop.md) - [Face Crop](https://techdocs.akamai.com/ivm/docs/face-crop.md) - [Feature Crop](https://techdocs.akamai.com/ivm/docs/feature-crop.md) - [Fit and Fill](https://techdocs.akamai.com/ivm/docs/fit-fill.md) - [Goop](https://techdocs.akamai.com/ivm/docs/goop.md) - [Grayscale](https://techdocs.akamai.com/ivm/docs/grayscale.md) - [Hue/Saturation/Lightness](https://techdocs.akamai.com/ivm/docs/hue-saturation-lightness.md) - [Hue/Saturation/Value](https://techdocs.akamai.com/ivm/docs/hue-saturation-value.md) - [If Dimension](https://techdocs.akamai.com/ivm/docs/if-dimension.md) - [If Orientation](https://techdocs.akamai.com/ivm/docs/if-orientation.md) - [IMQuery](https://techdocs.akamai.com/ivm/docs/imquery.md) - [Max Colors](https://techdocs.akamai.com/ivm/docs/max-colors.md) - [Mirror](https://techdocs.akamai.com/ivm/docs/mirror.md) - [Mono Hue](https://techdocs.akamai.com/ivm/docs/mono-hue.md) - [Opacity](https://techdocs.akamai.com/ivm/docs/opacity.md) - [Region of Interest Crop](https://techdocs.akamai.com/ivm/docs/region-of-interest.md) - [Relative Crop](https://techdocs.akamai.com/ivm/docs/relative-crop.md) - [Remove Color](https://techdocs.akamai.com/ivm/docs/remove-color.md) - [Resize](https://techdocs.akamai.com/ivm/docs/resize.md) - [Rotate](https://techdocs.akamai.com/ivm/docs/rotate.md) - [Scale](https://techdocs.akamai.com/ivm/docs/scale.md) - [Shear](https://techdocs.akamai.com/ivm/docs/shear.md) - [Smart Crop](https://techdocs.akamai.com/ivm/docs/smart-crop.md) - [Trim](https://techdocs.akamai.com/ivm/docs/trim.md) - [Unsharp Mask](https://techdocs.akamai.com/ivm/docs/unsharp-mask.md) - [Manage your policy sets and policies](https://techdocs.akamai.com/ivm/docs/manage-policies.md) - [Purge images from the cache](https://techdocs.akamai.com/ivm/docs/bp-purge-image-cache.md) - [Purge videos from the cache](https://techdocs.akamai.com/ivm/docs/bp-purge-video-cache.md) - [Monitor image and video traffic](https://techdocs.akamai.com/ivm/docs/monitor-ivm-traffic.md) - [Gather information using Piez](https://techdocs.akamai.com/ivm/docs/optimization-details-in-piez.md) - [Adapt for slow connections](https://techdocs.akamai.com/ivm/docs/adapt-for-slow-connections.md) - [Add text overlay to an image](https://techdocs.akamai.com/ivm/docs/add-text-overlay.md) - [Add a company logo or watermark to an image](https://techdocs.akamai.com/ivm/docs/add-logo-watermark.md) - [Convert Animated GIF to MP4](https://techdocs.akamai.com/ivm/docs/convert-animated-gif-to-mp4.md) - [Create a mobile-friendly hero image](https://techdocs.akamai.com/ivm/docs/create-hero-image.md) - [Crop around important faces or features](https://techdocs.akamai.com/ivm/docs/smart-crop-faces-features.md) - [Create a scaled thumbnail](https://techdocs.akamai.com/ivm/docs/create-scaled-thumbnail.md) - [Crop an image](https://techdocs.akamai.com/ivm/docs/crop-an-image.md) - [Crop around a focal point](https://techdocs.akamai.com/ivm/docs/crop-around-focal-point.md) - [Display images using the filename or path](https://techdocs.akamai.com/ivm/docs/display-using-path-or-filename.md) - [Dynamically resize images](https://techdocs.akamai.com/ivm/docs/dynamically-resize-images.md) - [Resize images to fit an image grid](https://techdocs.akamai.com/ivm/docs/resize-images-to-fit-grid.md) - [Reduce an image to fill a shape](https://techdocs.akamai.com/ivm/docs/reduce-to-fill-shape-diff-aspect-ratio.md) - [Select a specific derivative image or video](https://techdocs.akamai.com/ivm/docs/select-specific-derivative.md) - [Share a policy across multiple properties](https://techdocs.akamai.com/ivm/docs/shared-policy-sets.md) - [Use a placeholder video](https://techdocs.akamai.com/ivm/docs/add-placeholder-video.md) - [Use query string parameters to apply transformations](https://techdocs.akamai.com/ivm/docs/use-query-string-param-to-change-images.md) - [Validate optimization using Piez](https://techdocs.akamai.com/ivm/docs/validate-using-piez.md) - [Troubleshooting tips](https://techdocs.akamai.com/ivm/docs/troubleshooting-tips.md) - [Derivative images in unexpected format](https://techdocs.akamai.com/ivm/docs/images-were-transformed-into-an-unexpected-format.md) - [Images on mobile are heavier than expected](https://techdocs.akamai.com/ivm/docs/transformed-img-mobile-heavier-than-expected.md) - [Unprocessable images](https://techdocs.akamai.com/ivm/docs/unprocessable-images.md) - [Unprocessable videos](https://techdocs.akamai.com/ivm/docs/unprocessable-videos.md) - [Delivered image is larger in bytes than the pristine image](https://techdocs.akamai.com/ivm/docs/delivered-image-is-larger-than-pristine.md) ## API Reference - [Image and Video Manager API v2](https://techdocs.akamai.com/ivm/reference/api.md) - [API summary](https://techdocs.akamai.com/ivm/reference/api-summary.md) - [Get started](https://techdocs.akamai.com/ivm/reference/get-started.md) - [IVM Concepts](https://techdocs.akamai.com/ivm/reference/concepts.md) - [Rate limits](https://techdocs.akamai.com/ivm/reference/rate-limits.md) - [Test images on-demand](https://techdocs.akamai.com/ivm/reference/test-images-on-demand.md) - [Transformation types](https://techdocs.akamai.com/ivm/reference/transformation-types.md) - [Enumeration values](https://techdocs.akamai.com/ivm/reference/enum-values.md) - [Workflow](https://techdocs.akamai.com/ivm/reference/workflow.md) - [Errors](https://techdocs.akamai.com/ivm/reference/api-errors.md) - [400](https://techdocs.akamai.com/ivm/reference/400.md) - [404](https://techdocs.akamai.com/ivm/reference/404.md) - [List images](https://techdocs.akamai.com/ivm/reference/get-images.md): List a policy's images. - [Get an image](https://techdocs.akamai.com/ivm/reference/get-image.md): Returns a specific image. - [List policies](https://techdocs.akamai.com/ivm/reference/get-policies.md): Returns a list of all policies belonging to the specified policy set. - [Roll back a policy](https://techdocs.akamai.com/ivm/reference/put-rollback-policy.md): Use this operation to revert the previous version of the policy and deploy it to the network. Use this operation to stop and reverse a policy rollout. - [Get a policy](https://techdocs.akamai.com/ivm/reference/get-policy.md): Returns a specific policy assigned to the specified policy set. - [Create or modify a policy](https://techdocs.akamai.com/ivm/reference/put-policy.md): Run this operation to update an existing policy or create a new policy. Run the [List policies](ref:get-policies) operation to get the list of existing policies and their policy IDs. Confirm the `policyId` doesn't already exist. - [Remove a policy](https://techdocs.akamai.com/ivm/reference/delete-policy.md): Delete a specific policy. - [Get policy history](https://techdocs.akamai.com/ivm/reference/get-policy-history.md): Returns the policy history by policy ID. This operation returns the full state of the policy at various points in time. Time stamps are in ISO 8601 extended notation format. - [Create a policy set](https://techdocs.akamai.com/ivm/reference/post-policyset.md): Create a new policy set for the contract on both networks. - [List policy sets](https://techdocs.akamai.com/ivm/reference/get-policysets.md): Returns a list of all policy sets for a contract in production. - [Get a policy set](https://techdocs.akamai.com/ivm/reference/get-policyset.md): View details for a specific policy set in production. - [Update a policy set](https://techdocs.akamai.com/ivm/reference/put-policyset.md): Update the `name` or `region` of an existing policy set on both networks. - [Delete a policy set](https://techdocs.akamai.com/ivm/reference/delete-policyset.md): Delete a policy set from a contract on both networks. - [List error details](https://techdocs.akamai.com/ivm/reference/get-errors.md): Returns a list of image or video errors for the transformations requested in the past three days. - [List log details](https://techdocs.akamai.com/ivm/reference/get-logs.md): Returns a list of image or video logs for the transformations requested in the past three days. ## Recipes - [Create or modify a policy](https://techdocs.akamai.com/ivm/recipes/create-or-modify-a-policy.md) - [Get a specific image](https://techdocs.akamai.com/ivm/recipes/get-a-specific-image.md) - [Get a specific policy](https://techdocs.akamai.com/ivm/recipes/get-a-specific-policy.md) - [Get the history for a policy](https://techdocs.akamai.com/ivm/recipes/get-the-history-for-a-policy.md) - [List errors](https://techdocs.akamai.com/ivm/recipes/list-errors.md) - [List image and video logs](https://techdocs.akamai.com/ivm/recipes/list-image-and-video-logs.md) - [List your policies](https://techdocs.akamai.com/ivm/recipes/list-your-policies.md) ## Changelog - [Oct 1, 2024 – YuNet algorithm for enhanced face detection](https://techdocs.akamai.com/ivm/changelog/oct-1-2024-yunet-algorithm-for-enhanced-face-detection.md) - [June 4, 2024 — Convert Animated GIF to MP4, and IVM Dashboard and Reporting Updates](https://techdocs.akamai.com/ivm/changelog/jun-4-2024-convert-animated-gif-to-mp4.md) - [May 15, 2024 — AVIF and HEIF image formats update to SharpYUV Chroma Subsampling](https://techdocs.akamai.com/ivm/changelog/may-15-2024-avif-and-heif-image-formats-update-to-sharpyuv-chroma-subsampling.md) - [May 31, 2023 — Image & Video Manager updates](https://techdocs.akamai.com/ivm/changelog/may-31-2023-.md) - [February 22, 2023 — Image & Video Manager updates](https://techdocs.akamai.com/ivm/changelog/february-22-2023-image-video-manager-updates.md) # Invoicing API Documentation > Use the Akamai Invoicing API to develop your own tools to track invoice files, and keep others updated about their status. ## API Reference - [Invoicing API v4](https://techdocs.akamai.com/invoicing/reference/api.md) - [API summary](https://techdocs.akamai.com/invoicing/reference/api-summary.md) - [Get started](https://techdocs.akamai.com/invoicing/reference/get-started.md) - [API concepts](https://techdocs.akamai.com/invoicing/reference/api-concepts.md) - [API workflows](https://techdocs.akamai.com/invoicing/reference/workflows.md) - [Rate limits](https://techdocs.akamai.com/invoicing/reference/rate-limits.md) - [Errors](https://techdocs.akamai.com/invoicing/reference/errors.md) - [400](https://techdocs.akamai.com/invoicing/reference/400.md) - [401](https://techdocs.akamai.com/invoicing/reference/401.md) - [403](https://techdocs.akamai.com/invoicing/reference/403.md) - [404](https://techdocs.akamai.com/invoicing/reference/404.md) - [405](https://techdocs.akamai.com/invoicing/reference/405.md) - [429](https://techdocs.akamai.com/invoicing/reference/429.md) - [500](https://techdocs.akamai.com/invoicing/reference/500.md) - [List bills for a contract](https://techdocs.akamai.com/invoicing/reference/get-contracts-invoices.md): Returns invoices, credit memos, and debit memos for the specified contract and the selected month. - [Download a bill file](https://techdocs.akamai.com/invoicing/reference/get-contract-invoice-download.md): Returns the content of the selected contract's invoice, credit memo, debit memo file, or usage data for Cloud Computing services. The downloadable file is available in the response body. The format of the file depends on the value of the `Accept` header. Available formats are `CSV`, `PDF`, and `JSON`. - [List bills for an account](https://techdocs.akamai.com/invoicing/reference/get-invoices.md): Returns invoices, credit memos, and debit memos for the current account and the selected month. - [Create a notification](https://techdocs.akamai.com/invoicing/reference/post-notification.md): Creates a notification informing a set of users about new invoices, credit memos, or debit memos for a set of contracts. Each notification needs to specify a unique set of contracts. The request yields an error if the set of `contractId` values matches that of another notification. - [List notifications for an account](https://techdocs.akamai.com/invoicing/reference/get-notifications.md): Returns notifications for the current account. Notifications inform a set of users whenever there are changes to an invoice, credit memo, or debit memo. - [Get a notification](https://techdocs.akamai.com/invoicing/reference/get-notification.md): Accesses a specific notification, for example when making modifications to a specific notification. - [Modify a notification](https://techdocs.akamai.com/invoicing/reference/put-notification.md): Updates a notification. Any read-only members retained from a GET operation are ignored on subsequent PUTs. - [Remove a notification](https://techdocs.akamai.com/invoicing/reference/delete-notification.md): Deletes a notification. ## Recipes - [Create a notification](https://techdocs.akamai.com/invoicing/recipes/create-a-notification.md) - [Download a bill file](https://techdocs.akamai.com/invoicing/recipes/download-a-bill-file.md) - [Get a notification](https://techdocs.akamai.com/invoicing/recipes/get-a-notification-1.md) - [List account's bills](https://techdocs.akamai.com/invoicing/recipes/list-accounts-bills.md) - [List account's notifications](https://techdocs.akamai.com/invoicing/recipes/list-accounts-notifications.md) - [List contract's bills](https://techdocs.akamai.com/invoicing/recipes/list-contracts-bills.md) - [Modify a notification](https://techdocs.akamai.com/invoicing/recipes/modify-a-notification.md) - [Remove a notification](https://techdocs.akamai.com/invoicing/recipes/remove-a-notification.md) ## Changelog - [Feb 11, 2026 - Invoicing API v3 sunset](https://techdocs.akamai.com/invoicing/changelog/feb-11-2026-invoicing-api-v3-sunset.md) - [Jun 17, 2024 - New Invoicing API](https://techdocs.akamai.com/invoicing/changelog/jun-17-2024-new-invoicing-api.md) - [Jan 5, 2022 — New Invoicing API documentation experience](https://techdocs.akamai.com/invoicing/changelog/jan-5-2022-new-invoicing-api-documentation-experience.md) # Ion Documentation > No matter how users choose to connect, Akamai Ion offers them a seamless experience across different device types and network conditions. Akamai continuously monitors real users, automatically applies best practice performance optimizations, and adapts experiences as content, user behavior, and network conditions change. Ion combines the scalability of Akamai’s global content delivery platform with fast dynamic content acceleration. Ion also leverages Akamai cellular optimizations that lower both latency and user engagement disruptions. ## Guides - [Welcome to Ion](https://techdocs.akamai.com/ion/docs/welcome-ion.md) - [Delivery concepts and terms](https://techdocs.akamai.com/ion/docs/delivery-concepts-and-terms.md) - [Gather some information](https://techdocs.akamai.com/ion/docs/get-your-unique-information.md) - [Understand the request flow](https://techdocs.akamai.com/ion/docs/understand-the-connections.md) - [Prepare your environment](https://techdocs.akamai.com/ion/docs/prepare-your-environment.md) - [Create a new guided Ion property](https://techdocs.akamai.com/ion/docs/create-a-new-guided-ion-property.md) - [Create a new custom Ion property](https://techdocs.akamai.com/ion/docs/create-a-new-ion-property.md) - [Define property hostnames](https://techdocs.akamai.com/ion/docs/define-property-hostnames.md) - [Define property variables (optional)](https://techdocs.akamai.com/ion/docs/define-property-variables-optional.md) - [Define property configuration settings](https://techdocs.akamai.com/ion/docs/define-property-configuration-settings.md) - [Configure the Default Rule](https://techdocs.akamai.com/ion/docs/set-up-your-origin-server.md) - [Configure the Augment insights rule](https://techdocs.akamai.com/ion/docs/the-augment-insights-rule.md) - [Configure the Accelerate delivery rule](https://techdocs.akamai.com/ion/docs/configure-the-accelerate-delivery-rule.md) - [Configure the Offload origin rule](https://techdocs.akamai.com/ion/docs/configure-the-origin-offload-rule.md) - [Configure the Strengthen security rule](https://techdocs.akamai.com/ion/docs/configure-the-strengthen-security-rule.md) - [Configure the Increase availability rule](https://techdocs.akamai.com/ion/docs/configure-the-increase-availability-rule.md) - [Configure the Minimize payload rule](https://techdocs.akamai.com/ion/docs/configure-the-minimize-payload-rule.md) - [Finalize your Ion property](https://techdocs.akamai.com/ion/docs/finalize-your-ion-property.md) - [Test your Ion property](https://techdocs.akamai.com/ion/docs/test-your-ion-property.md) - [Go live with Ion](https://techdocs.akamai.com/ion/docs/go-live-with-ion.md) - [Protect connections with mTLS](https://techdocs.akamai.com/ion/docs/protect-connections-with-mtls.md) - [Improve page load performance](https://techdocs.akamai.com/ion/docs/set-up-adaptive-acceleration.md) - [Reduce poor script performance](https://techdocs.akamai.com/ion/docs/set-up-script-management.md) - [Prerender pages with Speculation Rules](https://techdocs.akamai.com/ion/docs/prerender-pages-with-speculation-rules.md) - [Adaptive Image Compression](https://techdocs.akamai.com/ion/docs/adaptive-image-compression.md) - [Auth Token 2.0 Verification](https://techdocs.akamai.com/ion/docs/auth-token-20-verification-and-ion.md) - [Breadcrumbs](https://techdocs.akamai.com/ion/docs/breadcrumbs-ion.md) - [Client Hints](https://techdocs.akamai.com/ion/docs/client-hints.md) - [Cloud Interconnects for Google Cloud (GCP)](https://techdocs.akamai.com/ion/docs/cloud-interconnects-for-google-cloud-gcp-ion.md) - [Cloud Wrapper](https://techdocs.akamai.com/ion/docs/cloud-wrapper.md) - [Connect Timeout](https://techdocs.akamai.com/ion/docs/connect-timeout.md) - [DataStream](https://techdocs.akamai.com/ion/docs/datastream-ion.md) - [Device Characterization](https://techdocs.akamai.com/ion/docs/device-characterization-ion.md) - [Early Data (0-RTT)](https://techdocs.akamai.com/ion/docs/early-data-0-rtt.md) - [Early Hints](https://techdocs.akamai.com/ion/docs/early-hints.md) - [Edge IP Binding](https://techdocs.akamai.com/ion/docs/edge-ip-binding.md) - [EdgeWorkers](https://techdocs.akamai.com/ion/docs/edgeworkers.md) - [Enhanced Debug](https://techdocs.akamai.com/ion/docs/enhanced-debug.md) - [Enhanced Proxy Detection](https://techdocs.akamai.com/ion/docs/enhanced-proxy-detection-ion.md) - [Manual Preconnect (legacy)](https://techdocs.akamai.com/ion/docs/manual-preconnect-ion.md) - [Manual Server Push (legacy)](https://techdocs.akamai.com/ion/docs/manual-server-push-ion.md) - [Mobile Detection and Redirect](https://techdocs.akamai.com/ion/docs/mobile-detect-and-redirect-ion.md) - [Origin IP access control list](https://techdocs.akamai.com/ion/docs/origin-ip-acl.md) - [Purge Cache](https://techdocs.akamai.com/ion/docs/purge-cache-ion.md) - [Read Timeout](https://techdocs.akamai.com/ion/docs/read-timeout.md) - [TCP Optimizations](https://techdocs.akamai.com/ion/docs/tcp-optimizations-ion.md) - [View Ion traffic reports](https://techdocs.akamai.com/ion/docs/view-ion-traffic-reports.md) - [Ion service-level agreement](https://techdocs.akamai.com/ion/docs/ion-service-level-agreement.md) ## API Reference - [APIs and Ion](https://techdocs.akamai.com/ion/reference/apis-and-ion.md) - [Before you begin](https://techdocs.akamai.com/ion/reference/before-you-begin.md) - [Create an Ion Property](https://techdocs.akamai.com/ion/reference/create-an-ion-property.md) - [Improve page load performance](https://techdocs.akamai.com/ion/reference/add-manage-adaptive-acceleration.md) - [Add A/B testing support](https://techdocs.akamai.com/ion/reference/enable-ab-testing.md) - [Reduce poor script performance](https://techdocs.akamai.com/ion/reference/add-script-management-support.md) ## Changelog - [Jan 30, 2026 – Support for gRPC Web](https://techdocs.akamai.com/ion/changelog/jan-30-2026-support-for-grpc-web.md) - [Oct 6, 2025 – Update for the migration from Resource Optimizer to Brotli Compression](https://techdocs.akamai.com/ion/changelog/oct-6-2025-update-for-the-migration-from-resource-optimizer-to-brotli-compression.md) - [Oct 8, 2024 – Update to Origin IP ACL support](https://techdocs.akamai.com/ion/changelog/oct-8-2024-update-to-origin-ip-acl-support.md) - [Sep 30, 2024 – New Enhanced Debug and Early Data behaviors](https://techdocs.akamai.com/ion/changelog/sep-30-2024-new-enhanced-debug-and-early-data-behaviors.md) - [Aug 28, 2024 – Read Timeout and Connect Timeout updates](https://techdocs.akamai.com/ion/changelog/aug-28-2024-read-timeout-and-connect-timeout-updates.md) # IP Accelerator Documentation > Akamai's IP Accelerator (IPA) empowers you to achieve organizational agility by leveraging the Internet as a standard platform for delivering accelerated TCP/IP based enterprise applications to any user, on any device, anywhere in the world. Use IPA to improve the performance of your IP-based applications while avoiding the high capital expenditure often associated with private-WAN infrastructure. IPA also allows you to leverage key optimization technologies already integrated into Akamai's globally distributed platform such as dynamic mapping, route optimization, packet redundancy, and a high-performance transport protocol. ## Guides - [Welcome to IP Accelerator](https://techdocs.akamai.com/ip-accelerator/docs/welcome-ipa.md) - [Prerequisites](https://techdocs.akamai.com/ip-accelerator/docs/prerequisites.md) - [Key concepts and terms](https://techdocs.akamai.com/ip-accelerator/docs/key-concepts.md) - [How IPA works](https://techdocs.akamai.com/ip-accelerator/docs/how-it-works.md) - [Key capabilities](https://techdocs.akamai.com/ip-accelerator/docs/key-capabilities.md) - [Additional features](https://techdocs.akamai.com/ip-accelerator/docs/additional-features.md) - [Security considerations](https://techdocs.akamai.com/ip-accelerator/docs/security-considerations.md) - [Configuration overview](https://techdocs.akamai.com/ip-accelerator/docs/configure.md) - [View configuration settings](https://techdocs.akamai.com/ip-accelerator/docs/view-settings.md) - [Create a security policy](https://techdocs.akamai.com/ip-accelerator/docs/security-policy.md) - [CPE deployments](https://techdocs.akamai.com/ip-accelerator/docs/cpe-deployments.md) - [View traffic reports](https://techdocs.akamai.com/ip-accelerator/docs/traffic-reports.md) - [Create alerts](https://techdocs.akamai.com/ip-accelerator/docs/alerts.md) # Linode API Documentation > Programmatically create Linode instances, deploy Kubernetes clusters, and use the full range of Akamai cloud computing products and services. ## API Reference - [Linode API v4](https://techdocs.akamai.com/linode-api/reference/api.md) - [API summary](https://techdocs.akamai.com/linode-api/reference/api-summary.md) - [Get started](https://techdocs.akamai.com/linode-api/reference/get-started.md) - [API workflows](https://techdocs.akamai.com/linode-api/reference/api-workflow.md) - [Reboot your Linodes for QEMU maintenance](https://techdocs.akamai.com/linode-api/reference/reboot-your-linodes-for-qemu-maintenance.md) - [Restore a Managed Database backup](https://techdocs.akamai.com/linode-api/reference/restore-a-managed-database-backup.md) - [Configure the SSO login](https://techdocs.akamai.com/linode-api/reference/configure-sso-login.md) - [Capture an image](https://techdocs.akamai.com/linode-api/reference/capture-an-image.md) - [Upload an image](https://techdocs.akamai.com/linode-api/reference/upload-an-image.md) - [Deploy an image](https://techdocs.akamai.com/linode-api/reference/deploy-an-image.md) - [Create a Linode using a public image](https://techdocs.akamai.com/linode-api/reference/create-a-linode-using-a-public-image.md) - [Create a Linode using a private image](https://techdocs.akamai.com/linode-api/reference/create-a-linode-using-a-private-image.md) - [Create a Linode using a backup](https://techdocs.akamai.com/linode-api/reference/create-a-linode-using-a-backup.md) - [Create a Linode using a StackScript](https://techdocs.akamai.com/linode-api/reference/create-a-linode-using-a-stackscript.md) - [Configure audit log delivery](https://techdocs.akamai.com/linode-api/reference/config-audit-log-delivery.md) - [Create an unlimited access Object Storage key](https://techdocs.akamai.com/linode-api/reference/create-an-unlimited-access-key.md) - [Create a limited access Object Storage key](https://techdocs.akamai.com/linode-api/reference/create-a-limited-access-key.md) - [Create a placement group](https://techdocs.akamai.com/linode-api/reference/create-a-placement-group.md) - [Create a resource lock for a Linode](https://techdocs.akamai.com/linode-api/reference/create-a-resource-lock-for-a-linode.md) - [Rate limits](https://techdocs.akamai.com/linode-api/reference/rate-limits.md) - [Pagination](https://techdocs.akamai.com/linode-api/reference/pagination.md) - [Filtering and sorting](https://techdocs.akamai.com/linode-api/reference/filtering-and-sorting.md) - [Time values](https://techdocs.akamai.com/linode-api/reference/time-values.md) - [Response headers](https://techdocs.akamai.com/linode-api/reference/response-headers.md) - [Command line interface (CLI)](https://techdocs.akamai.com/linode-api/reference/cli.md) - [Errors](https://techdocs.akamai.com/linode-api/reference/errors.md) - [299](https://techdocs.akamai.com/linode-api/reference/299.md) - [400](https://techdocs.akamai.com/linode-api/reference/400.md) - [401](https://techdocs.akamai.com/linode-api/reference/401.md) - [403](https://techdocs.akamai.com/linode-api/reference/403.md) - [404](https://techdocs.akamai.com/linode-api/reference/404.md) - [405](https://techdocs.akamai.com/linode-api/reference/405.md) - [406](https://techdocs.akamai.com/linode-api/reference/406.md) - [415](https://techdocs.akamai.com/linode-api/reference/415.md) - [429](https://techdocs.akamai.com/linode-api/reference/429.md) - [500](https://techdocs.akamai.com/linode-api/reference/500.md) - [504](https://techdocs.akamai.com/linode-api/reference/504.md) - [Get your account](https://techdocs.akamai.com/linode-api/reference/get-account.md): Returns the contact and billing information related to your account. **Permissions and scopes** To call this operation, you need permissions, based on the model you're using: - **Identity and access permissions**. Your user needs a role with these permissions. [Learn more](https://techdocs.akamai.com/cloud-computing/docs/identity-access-cm-available-roles). - Permissions: `view_account` - **OAuth scopes**. Your user needs these scopes assigned. [Learn more](https://techdocs.akamai.com/linode-api/reference/get-started#oauth). - Scopes: `account:read_only` **CLI** ```shell linode-cli account view ``` [Learn more](https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli) - [Update your account](https://techdocs.akamai.com/linode-api/reference/put-account.md): Updates contact and billing information related to your account. If you exclude any properties from the request, the operation leaves them unchanged. > 📘 > > When updating an account's `country` to `US`, you'll get an error if the account's `zip` is not a valid US zip code. __Parent and child accounts__ In the context of the [parent and child accounts](https://techdocs.akamai.com/cloud-computing/docs/parent-and-child-accounts-for-akamai-partners) feature: - You can't change the company for a parent account. - Child account users can't run this operation. **Permissions and scopes** To call this operation, you need permissions, based on the model you're using: - **Identity and access permissions**. Your user needs a role with these permissions. [Learn more](https://techdocs.akamai.com/cloud-computing/docs/identity-access-cm-available-roles). - Permissions: `update_account` - **OAuth scopes**. Your user needs these scopes assigned. [Learn more](https://techdocs.akamai.com/linode-api/reference/get-started#oauth). - Scopes: `account:read_write` **CLI** ```shell linode-cli account update \ --address_1 "123 Main St." \ --address_2 "Suite 101" \ --city Philadelphia \ --company My Company \ LLC \ --country US \ --email jsmith@mycompany.com \ --first_name John \ --last_name Smith \ --phone 555-555-1212 \ --state PA \ --tax_id ATU99999999 \ --zip 19102 ``` [Learn more](https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli) - [Get available services for a region](https://techdocs.akamai.com/linode-api/reference/get-account-availability.md): View the available services for your account, in a specific region. **Permissions and scopes** To call this operation, you need permissions, based on the model you're using: - **Identity and access permissions**. Your user needs a role with these permissions. [Learn more](https://techdocs.akamai.com/cloud-computing/docs/identity-access-cm-available-roles). - Permissions: `view_region_available_service` - **OAuth scopes**. Your user needs these scopes assigned. [Learn more](https://techdocs.akamai.com/linode-api/reference/get-started#oauth). - Scopes: `account:read_only` **CLI** ```shell linode-cli account get-account-availability us-east ``` [Learn more](https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli) - [Delete your account](https://techdocs.akamai.com/linode-api/reference/post-cancel-account.md): Deletes an active account. Akamai attempts to charge the credit card on file for any remaining balance. An error occurs if this charge fails. > 🚧 > > This operation permanently deletes your account, which _can't_ be recovered. Also, there is no warning prompt after you execute this operation. __Parent and child accounts__ In the context of the [parent and child accounts](https://techdocs.akamai.com/cloud-computing/docs/parent-and-child-accounts-for-akamai-partners) feature, you need to contact your Akamai account team to delete a child or parent account. **Permissions and scopes** To call this operation, you need permissions, based on the model you're using: - **Identity and access permissions**. Your user needs a role with these permissions. [Learn more](https://techdocs.akamai.com/cloud-computing/docs/identity-access-cm-available-roles). - Permissions: `cancel_account` - **OAuth scopes**. Your user needs these scopes assigned. [Learn more](https://techdocs.akamai.com/linode-api/reference/get-started#oauth). - Scopes: `account:read_write` **CLI** ```shell linode-cli account cancel \ --comments "I'm consolidating my accounts" ``` [Learn more](https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli) - [List available services](https://techdocs.akamai.com/linode-api/reference/get-availability.md): Returns a paginated list of the services available to you, for all Akamai Cloud Computing regions. **Permissions and scopes** To call this operation, you need permissions, based on the model you're using: - **Identity and access permissions**. Your user needs a role with these permissions. [Learn more](https://techdocs.akamai.com/cloud-computing/docs/identity-access-cm-available-roles). - Permissions: `list_available_services` - **OAuth scopes**. Your user needs these scopes assigned. [Learn more](https://techdocs.akamai.com/linode-api/reference/get-started#oauth). - Scopes: `account:read_only` **CLI** ```shell linode-cli account get-availability ``` [Learn more](https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli) - [Get account settings](https://techdocs.akamai.com/linode-api/reference/get-account-settings.md): Returns information related to your Account settings: Managed service subscription, interface settings for new Linodes, Longview subscription, and Network Helper. **Permissions and scopes** To call this operation, you need permissions, based on the model you're using: - **Identity and access permissions**. Your user needs a role with these permissions. [Learn more](https://techdocs.akamai.com/cloud-computing/docs/identity-access-cm-available-roles). - Permissions: `view_account_settings` - **OAuth scopes**. Your user needs these scopes assigned. [Learn more](https://techdocs.akamai.com/linode-api/reference/get-started#oauth). - Scopes: `account:read_only` **CLI** ```shell linode-cli account settings ``` [Learn more](https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli) - [Enable Linode Managed](https://techdocs.akamai.com/linode-api/reference/post-enable-account-managed.md): Enables Linode Managed for the entire account and sends a welcome email to the account's associated email address. Linode Managed can monitor any service or software stack reachable over TCP or HTTP. See our [Linode Managed guide](https://www.linode.com/docs/guides/linode-managed/) to learn more. **Permissions and scopes** To call this operation, you need permissions, based on the model you're using: - **Identity and access permissions**. Your user needs a role with these permissions. [Learn more](https://techdocs.akamai.com/cloud-computing/docs/identity-access-cm-available-roles). - Permissions: `enable_managed` - **OAuth scopes**. Your user needs these scopes assigned. [Learn more](https://techdocs.akamai.com/linode-api/reference/get-started#oauth). - Scopes: `account:read_write` **CLI** ```shell linode-cli account enable-managed ``` [Learn more](https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli) - [Update account settings](https://techdocs.akamai.com/linode-api/reference/put-account-settings.md): Updates your account settings. For a Longview subscription plan, see [Update a Longview plan](ref:put-longview-plan). **Permissions and scopes** To call this operation, you need permissions, based on the model you're using: - **Identity and access permissions**. Your user needs a role with these permissions. [Learn more](https://techdocs.akamai.com/cloud-computing/docs/identity-access-cm-available-roles). - Permissions: `update_account_settings` - **OAuth scopes**. Your user needs these scopes assigned. [Learn more](https://techdocs.akamai.com/linode-api/reference/get-started#oauth). - Scopes: `account:read_write` **CLI** ```shell linode-cli account settings-update \ --network_helper false ``` [Learn more](https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli) - [Acknowledge agreements](https://techdocs.akamai.com/linode-api/reference/post-account-agreements.md): Accept required agreements by setting them to `true`. This remains until the content of the agreement changes. If it does, you need to run this operation again to accept it. If you set this to `false`, the API rejects the request and you need to open a [support ticket](ref:post-ticket) to reset the agreement. Omitted agreements are left unchanged. **Permissions and scopes** To call this operation, you need permissions, based on the model you're using: - **Identity and access permissions**. Your user needs a role with these permissions. [Learn more](https://techdocs.akamai.com/cloud-computing/docs/identity-access-cm-available-roles). - Permissions: `acknowledge_account_agreement` - **OAuth scopes**. Your user needs these scopes assigned. [Learn more](https://techdocs.akamai.com/linode-api/reference/get-started#oauth). - Scopes: `account:read_write` - [List agreements](https://techdocs.akamai.com/linode-api/reference/get-account-agreements.md): Returns all agreements and their acceptance status for your account. **Permissions and scopes** To call this operation, you need permissions, based on the model you're using: - **Identity and access permissions**. Your user needs a role with these permissions. [Learn more](https://techdocs.akamai.com/cloud-computing/docs/identity-access-cm-available-roles). - Permissions: `list_account_agreements` - **OAuth scopes**. Your user needs these scopes assigned. [Learn more](https://techdocs.akamai.com/linode-api/reference/get-started#oauth). - Scopes: `account:read_only` - [Get network usage](https://techdocs.akamai.com/linode-api/reference/get-transfer.md): Returns a Transfer object showing your network utilization, in GB, for the current month. **Permissions and scopes** To call this operation, you need permissions, based on the model you're using: - **Identity and access permissions**. Your user needs a role with these permissions. [Learn more](https://techdocs.akamai.com/cloud-computing/docs/identity-access-cm-available-roles). - Permissions: `view_network_usage` - **OAuth scopes**. Your user needs these scopes assigned. [Learn more](https://techdocs.akamai.com/linode-api/reference/get-started#oauth). - Scopes: `account:read_only` **CLI** ```shell linode-cli account transfer ``` [Learn more](https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli) - [Enroll in a Beta program](https://techdocs.akamai.com/linode-api/reference/post-beta-program.md): Enroll your account in an active Beta program. When running this operation, consider these points: - To view active Beta programs, run the [List beta programs](ref:get-beta-programs) operation. - Active Beta programs may have a limited number of enrollments. If a program has reached its maximum number of enrollments, you'll get an error even though the request is successful. - Beta programs with `"greenlight_only": true` can only be enrolled in by an accounts that participates in the [Greenlight](https://www.linode.com/green-light/) program. **Permissions and scopes** To call this operation, you need permissions, based on the model you're using: - **Identity and access permissions**. Your user needs a role with these permissions. [Learn more](https://techdocs.akamai.com/cloud-computing/docs/identity-access-cm-available-roles). - Permissions: `enroll_beta_program` - **OAuth scopes**. Your user needs these scopes assigned. [Learn more](https://techdocs.akamai.com/linode-api/reference/get-started#oauth). - Scopes: `account:read_write` **CLI** ```shell linode-cli betas enroll --id example_open ``` [Learn more](https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli) - [List enrolled Beta programs](https://techdocs.akamai.com/linode-api/reference/get-enrolled-beta-programs.md): Display all enrolled Beta programs for your account. This includes both inactive and active programs. **Permissions and scopes** To call this operation, you need permissions, based on the model you're using: - **Identity and access permissions**. Your user needs a role with these permissions. [Learn more](https://techdocs.akamai.com/cloud-computing/docs/identity-access-cm-available-roles). - Permissions: `list_enrolled_beta_programs` - **OAuth scopes**. Your user needs these scopes assigned. [Learn more](https://techdocs.akamai.com/linode-api/reference/get-started#oauth). - Scopes: `account:read_only` **CLI** ```shell linode-cli betas enrolled ``` [Learn more](https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli) - [Get an enrolled Beta program](https://techdocs.akamai.com/linode-api/reference/get-enrolled-beta-program.md): Display an enrolled Beta program for your account. The Beta program may be inactive. **Permissions and scopes** To call this operation, you need permissions, based on the model you're using: - **Identity and access permissions**. Your user needs a role with these permissions. [Learn more](https://techdocs.akamai.com/cloud-computing/docs/identity-access-cm-available-roles). - Permissions: `view_enrolled_beta_program` - **OAuth scopes**. Your user needs these scopes assigned. [Learn more](https://techdocs.akamai.com/linode-api/reference/get-started#oauth). - Scopes: `account:read_only` **CLI** ```shell linode-cli betas enrolled-view $betaId ``` [Learn more](https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli) - [List child accounts (Deprecated)](https://techdocs.akamai.com/linode-api/reference/get-child-accounts.md): __Deprecated__ Returns a paginated list of child accounts you're part of the account delegations for. > 🚧 Parent and child accounts feature in Identity and Access > > With the introduction of Identity and Access, the parent and child accounts feature has changed. This operation is now deprecated, so use the [List child accounts](ref:get-iam-delegation-all-child-accounts) operation instead. To learn more about the changes, see [Changes to the parent and child accounts feature for migrated partners](https://techdocs.akamai.com/cloud-computing/docs/parent-child-migration-partner). **Permissions and scopes** To call this operation, you need permissions, based on the model you're using: - **OAuth scopes**. Your user needs these scopes assigned. [Learn more](https://techdocs.akamai.com/linode-api/reference/get-started#oauth). - Scopes: `child_account:read_only` **CLI** ```shell linode-cli child-account list ``` [Learn more](https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli) - [Get a child account (Deprecated)](https://techdocs.akamai.com/linode-api/reference/get-child-account.md): __Deprecated__ Returns details of a specific child account that you're part of the account delegation for. > 🚧 Parent and child accounts feature in Identity and Access > > With the introduction of Identity and Access, the parent and child accounts feature has changed. This operation is now deprecated, so use the [Get a child account](ref:get-delegation-profile-child-account) operation instead. To learn more about the changes to the parent and child accounts feature, see [Changes for migrated partners](https://techdocs.akamai.com/cloud-computing/docs/parent-child-migration-partner). **Permissions and scopes** To call this operation, you need permissions, based on the model you're using: - **OAuth scopes**. Your user needs these scopes assigned. [Learn more](https://techdocs.akamai.com/linode-api/reference/get-started#oauth). - Scopes: `child_account:read_only` **CLI** ```shell linode-cli child-account view A1BC2DEF-34GH-567I-J890KLMN12O34P56 ``` [Learn more](https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli) - [Create a proxy user token](https://techdocs.akamai.com/linode-api/reference/post-child-account-token.md): __Deprecated__ Creates a short-lived bearer token for a parent user on a specific child account. > 🚧 Parent and child accounts feature in Identity and Access > > With the introduction of Identity and Access, the parent and child accounts feature has changed. This operation is no longer available. Use the [Create a delegate user token](ref:post-iam-delegation-profile-child-account-token) operation instead. To learn more about the changes to the parent and child accounts feature, see [Changes for migrated partners](https://techdocs.akamai.com/cloud-computing/docs/parent-child-migration-partner). **Permissions and scopes** To call this operation, you need permissions, based on the model you're using: - **OAuth scopes**. Your user needs these scopes assigned. [Learn more](https://techdocs.akamai.com/linode-api/reference/get-started#oauth). - Scopes: `child_account:read_write` **CLI** ```shell linode-cli child-account create A1BC2DEF-34GH-567I-J890KLMN12O34P56 ``` [Learn more](https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli) - [Create an entity transfer](https://techdocs.akamai.com/linode-api/reference/post-entity-transfer.md): __Deprecated__ Run the [Request a service transfer](ref:post-service-transfer) operation instead. **Permissions and scopes** To call this operation, you need permissions, based on the model you're using: - **OAuth scopes**. Your user needs these scopes assigned. [Learn more](https://techdocs.akamai.com/linode-api/reference/get-started#oauth). - Scopes: `account:read_write` - [List entity transfers](https://techdocs.akamai.com/linode-api/reference/get-entity-transfers.md): __Deprecated__ Run the [List service transfers](ref:get-service-transfers) operation instead. **Permissions and scopes** To call this operation, you need permissions, based on the model you're using: - **OAuth scopes**. Your user needs these scopes assigned. [Learn more](https://techdocs.akamai.com/linode-api/reference/get-started#oauth). - Scopes: `account:read_only` - [Get an entity transfer](https://techdocs.akamai.com/linode-api/reference/get-entity-transfer.md): __Deprecated__ Run the [Get a service transfer request](ref:get-service-transfer) operation instead. **Permissions and scopes** To call this operation, you need permissions, based on the model you're using: - **OAuth scopes**. Your user needs these scopes assigned. [Learn more](https://techdocs.akamai.com/linode-api/reference/get-started#oauth). - Scopes: `account:read_only` - [Cancel an entity transfer](https://techdocs.akamai.com/linode-api/reference/delete-entity-transfer.md): __Deprecated__ Run the [Cancel a service transfer](ref:delete-service-transfer) operation instead. **Permissions and scopes** To call this operation, you need permissions, based on the model you're using: - **OAuth scopes**. Your user needs these scopes assigned. [Learn more](https://techdocs.akamai.com/linode-api/reference/get-started#oauth). - Scopes: `account:read_write` - [Accept an entity transfer](https://techdocs.akamai.com/linode-api/reference/post-accept-entity-transfer.md): __Deprecated__ Run the [Accept a service transfer](ref:post-accept-service-transfer) operation instead. **Permissions and scopes** To call this operation, you need permissions, based on the model you're using: - **OAuth scopes**. Your user needs these scopes assigned. [Learn more](https://techdocs.akamai.com/linode-api/reference/get-started#oauth). - Scopes: `account:read_write` - [List events](https://techdocs.akamai.com/linode-api/reference/get-events.md): Returns a collection of event objects that represent actions you've taken on your account, over the last 90 days. The events returned depend on your user permissions. **Permissions and scopes** To call this operation, you need permissions, based on the model you're using: - **Identity and access permissions**. Your user needs a role with these permissions. [Learn more](https://techdocs.akamai.com/cloud-computing/docs/identity-access-cm-available-roles). - Permissions: `list_events` - **OAuth scopes**. Your user needs these scopes assigned. [Learn more](https://techdocs.akamai.com/linode-api/reference/get-started#oauth). - Scopes: `events:read_only` **CLI** ```shell linode-cli events list ``` [Learn more](https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli) - [Get an event](https://techdocs.akamai.com/linode-api/reference/get-event.md): Returns a single event object. **Permissions and scopes** To call this operation, you need permissions, based on the model you're using: - **Identity and access permissions**. Your user needs a role with these permissions. [Learn more](https://techdocs.akamai.com/cloud-computing/docs/identity-access-cm-available-roles). - Permissions: `view_event` - **OAuth scopes**. Your user needs these scopes assigned. [Learn more](https://techdocs.akamai.com/linode-api/reference/get-started#oauth). - Scopes: `events:read_only` **CLI** ```shell linode-cli events view 123 ``` [Learn more](https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli) - [Mark an event as seen](https://techdocs.akamai.com/linode-api/reference/post-event-seen.md): Acknowledge an event by marking it as seen. **Permissions and scopes** To call this operation, you need permissions, based on the model you're using: - **Identity and access permissions**. Your user needs a role with these permissions. [Learn more](https://techdocs.akamai.com/cloud-computing/docs/identity-access-cm-available-roles). - Permissions: `mark_event_seen` - **OAuth scopes**. Your user needs these scopes assigned. [Learn more](https://techdocs.akamai.com/linode-api/reference/get-started#oauth). - Scopes: `events:read_only` **CLI** ```shell linode-cli events mark-seen 123 ``` [Learn more](https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli) - [List invoices](https://techdocs.akamai.com/linode-api/reference/get-invoices.md): Returns a paginated list of invoices against your account. **Permissions and scopes** To call this operation, you need permissions, based on the model you're using: - **Identity and access permissions**. Your user needs a role with these permissions. [Learn more](https://techdocs.akamai.com/cloud-computing/docs/identity-access-cm-available-roles). - Permissions: `list_billing_invoices` - **OAuth scopes**. Your user needs these scopes assigned. [Learn more](https://techdocs.akamai.com/linode-api/reference/get-started#oauth). - Scopes: `account:read_only` **CLI** ```shell linode-cli account invoices-list ``` [Learn more](https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli) - [Get an invoice](https://techdocs.akamai.com/linode-api/reference/get-invoice.md): Returns a single Invoice object. **Permissions and scopes** To call this operation, you need permissions, based on the model you're using: - **Identity and access permissions**. Your user needs a role with these permissions. [Learn more](https://techdocs.akamai.com/cloud-computing/docs/identity-access-cm-available-roles). - Permissions: `view_billing_invoice` - **OAuth scopes**. Your user needs these scopes assigned. [Learn more](https://techdocs.akamai.com/linode-api/reference/get-started#oauth). - Scopes: `account:read_only` **CLI** ```shell linode-cli account invoice-view 123 ``` [Learn more](https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli) - [List invoice items](https://techdocs.akamai.com/linode-api/reference/get-invoice-items.md): Returns a paginated list of Invoice items. **Permissions and scopes** To call this operation, you need permissions, based on the model you're using: - **Identity and access permissions**. Your user needs a role with these permissions. [Learn more](https://techdocs.akamai.com/cloud-computing/docs/identity-access-cm-available-roles). - Permissions: `list_invoice_items` - **OAuth scopes**. Your user needs these scopes assigned. [Learn more](https://techdocs.akamai.com/linode-api/reference/get-started#oauth). - Scopes: `account:read_only` **CLI** ```shell linode-cli account invoice-items 123 ``` [Learn more](https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli) - [List user logins](https://techdocs.akamai.com/linode-api/reference/get-account-logins.md): Returns a collection of successful logins for all users on the account during the last 90 days. **Permissions and scopes** To call this operation, you need permissions, based on the model you're using: - **Identity and access permissions**. Your user needs a role with these permissions. [Learn more](https://techdocs.akamai.com/cloud-computing/docs/identity-access-cm-available-roles). - Permissions: `list_profile_logins` - **OAuth scopes**. Your user needs these scopes assigned. [Learn more](https://techdocs.akamai.com/linode-api/reference/get-started#oauth). - Scopes: `account:read_only` **CLI** ```shell linode-cli account logins-list ``` [Learn more](https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli) - [Get an account login](https://techdocs.akamai.com/linode-api/reference/get-account-login.md): Returns a Login object that displays information about a successful login. The logins that can be viewed can be for any user on the account, and are not limited to only the logins of the user that is accessing this API endpoint. **Permissions and scopes** To call this operation, you need permissions, based on the model you're using: - **Identity and access permissions**. Your user needs a role with these permissions. [Learn more](https://techdocs.akamai.com/cloud-computing/docs/identity-access-cm-available-roles). - Permissions: `view_account_login` - **OAuth scopes**. Your user needs these scopes assigned. [Learn more](https://techdocs.akamai.com/linode-api/reference/get-started#oauth). - Scopes: `account:read_only` **CLI** ```shell linode-cli account login-view 1234 ``` [Learn more](https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli) - [List maintenances](https://techdocs.akamai.com/linode-api/reference/get-maintenance.md): Returns maintenance information for any entity your user has permissions to view. If a maintenance object has been canceled, it's not returned. > 📘 > > Currently, only Linodes are included as entities for viewing. **Permissions and scopes** To call this operation, you need permissions, based on the model you're using: - **Identity and access permissions**. Your user needs a role with these permissions. [Learn more](https://techdocs.akamai.com/cloud-computing/docs/identity-access-cm-available-roles). - Permissions: `list_maintenances` **CLI** ```shell linode-cli account maintenance-list ``` [Learn more](https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli) - [List notifications](https://techdocs.akamai.com/linode-api/reference/get-notifications.md): Returns notifications that represent important, often time-sensitive details about your account. You can't interact directly with notifications, and a notification disappears when you've resolved its cause. For example, if you have an important ticket open, you can respond to that ticket to dismiss its notification. **Permissions and scopes** To call this operation, you need permissions, based on the model you're using: - **Identity and access permissions**. Your user needs a role with these permissions. [Learn more](https://techdocs.akamai.com/cloud-computing/docs/identity-access-cm-available-roles). - Permissions: `list_notifications` - **OAuth scopes**. Your user needs these scopes assigned. [Learn more](https://techdocs.akamai.com/linode-api/reference/get-started#oauth). - Scopes: `account:read_only` **CLI** ```shell linode-cli account notifications-list ``` [Learn more](https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli) - [Create an OAuth client](https://techdocs.akamai.com/linode-api/reference/post-client.md): Creates an OAuth Client, which can be used to allow users (using their Linode account) to log in to your own application, and optionally grant your application some amount of access to their Linodes or other entities. **Permissions and scopes** To call this operation, you need permissions, based on the model you're using: - **Identity and access permissions**. Your user needs a role with these permissions. [Learn more](https://techdocs.akamai.com/cloud-computing/docs/identity-access-cm-available-roles). - Permissions: `create_oauth_client` - **OAuth scopes**. Your user needs these scopes assigned. [Learn more](https://techdocs.akamai.com/linode-api/reference/get-started#oauth). - Scopes: `account:read_write` **CLI** ```shell linode-cli account client-create \ --label Test_Client_1 \ --redirect_uri https://example.org/callback ``` [Learn more](https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli) - [List OAuth clients](https://techdocs.akamai.com/linode-api/reference/get-clients.md): Returns a paginated list of OAuth Clients registered to your Account. OAuth Clients allow users to log into applications you write or host using their Linode Account, and may allow them to grant some level of access to their Linodes or other entities to your application. **Permissions and scopes** To call this operation, you need permissions, based on the model you're using: - **Identity and access permissions**. Your user needs a role with these permissions. [Learn more](https://techdocs.akamai.com/cloud-computing/docs/identity-access-cm-available-roles). - Permissions: `list_oauth_clients` - **OAuth scopes**. Your user needs these scopes assigned. [Learn more](https://techdocs.akamai.com/linode-api/reference/get-started#oauth). - Scopes: `account:read_only` **CLI** ```shell linode-cli account clients-list ``` [Learn more](https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli) - [Get an OAuth client](https://techdocs.akamai.com/linode-api/reference/get-client.md): Returns information about a single OAuth client. **Permissions and scopes** To call this operation, you need permissions, based on the model you're using: - **Identity and access permissions**. Your user needs a role with these permissions. [Learn more](https://techdocs.akamai.com/cloud-computing/docs/identity-access-cm-available-roles). - Permissions: `view_oauth_client` - **OAuth scopes**. Your user needs these scopes assigned. [Learn more](https://techdocs.akamai.com/linode-api/reference/get-started#oauth). - Scopes: `account:read_only` **CLI** ```shell linode-cli account client-view \ edc6790ea9db4d224c5c ``` [Learn more](https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli) - [Update an OAuth client](https://techdocs.akamai.com/linode-api/reference/put-client.md): Update information about an OAuth Client on your Account. This can be especially useful to update the `redirect_uri` of your client in the event that the callback URL changed in your application. **Permissions and scopes** To call this operation, you need permissions, based on the model you're using: - **Identity and access permissions**. Your user needs a role with these permissions. [Learn more](https://techdocs.akamai.com/cloud-computing/docs/identity-access-cm-available-roles). - Permissions: `update_oauth_client` - **OAuth scopes**. Your user needs these scopes assigned. [Learn more](https://techdocs.akamai.com/linode-api/reference/get-started#oauth). - Scopes: `account:read_write` **CLI** ```shell linode-cli account client-update \ edc6790ea9db4d224c5c \ --label Test_Client_1 ``` [Learn more](https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli) - [Delete an OAuth client](https://techdocs.akamai.com/linode-api/reference/delete-client.md): Deletes an OAuth Client registered with Linode. The Client ID and Client secret will no longer be accepted by [login.linode.com](https://login.linode.com), and all tokens issued to this client will be invalidated (meaning that if your application was using a token, it will no longer work). **Permissions and scopes** To call this operation, you need permissions, based on the model you're using: - **Identity and access permissions**. Your user needs a role with these permissions. [Learn more](https://techdocs.akamai.com/cloud-computing/docs/identity-access-cm-available-roles). - Permissions: `delete_oauth_client` - **OAuth scopes**. Your user needs these scopes assigned. [Learn more](https://techdocs.akamai.com/linode-api/reference/get-started#oauth). - Scopes: `account:read_write` **CLI** ```shell linode-cli account client-delete \ edc6790ea9db4d224c5c ``` [Learn more](https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli) - [Reset an OAuth client secret](https://techdocs.akamai.com/linode-api/reference/post-reset-client-secret.md): Resets the OAuth Client secret for a client you own, and returns the OAuth Client with the plaintext secret. This secret is not supposed to be publicly known or disclosed anywhere. This can be used to generate a new secret in case the one you have has been leaked, or to get a new secret if you lost the original. The old secret is expired immediately, and logins to your client with the old secret will fail. **Permissions and scopes** To call this operation, you need permissions, based on the model you're using: - **Identity and access permissions**. Your user needs a role with these permissions. [Learn more](https://techdocs.akamai.com/cloud-computing/docs/identity-access-cm-available-roles). - Permissions: `reset_oauth_client_secret` - **OAuth scopes**. Your user needs these scopes assigned. [Learn more](https://techdocs.akamai.com/linode-api/reference/get-started#oauth). - Scopes: `account:read_write` **CLI** ```shell linode-cli account client-reset-secret \ edc6790ea9db4d224c5c ``` [Learn more](https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli) - [Add a payment method](https://techdocs.akamai.com/linode-api/reference/post-payment-method.md): Adds a Payment Method to your Account with the option to set it as the default method. - Adding a default Payment Method removes the default status from any other Payment Method. - An Account can have up to 6 active Payment Methods. - Up to 60 Payment Methods can be added each day. - Prior to adding a Payment Method, ensure that your billing address information is up-to-date with a valid `zip` by running the [Update your account](ref:put-account) operation. - A `payment_method_add` event is generated when a payment is successfully submitted. __Parent and child accounts__ In the context of the [parent and child accounts](https://techdocs.akamai.com/cloud-computing/docs/parent-and-child-accounts-for-akamai-partners) feature, this operation isn't available for child account users. **Permissions and scopes** To call this operation, you need permissions, based on the model you're using: - **Identity and access permissions**. Your user needs a role with these permissions. [Learn more](https://techdocs.akamai.com/cloud-computing/docs/identity-access-cm-available-roles). - Permissions: `create_payment_method` - **OAuth scopes**. Your user needs these scopes assigned. [Learn more](https://techdocs.akamai.com/linode-api/reference/get-started#oauth). - Scopes: `account:read_write` **CLI** ```shell linode-cli payment-methods add \ --type credit_card \ --is_default true \ --data.card_number 4111111111111111 \ --data.expiry_month 11 \ --data.expiry_year 2020 \ --data.cvv 111 ``` [Learn more](https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli) - [List payment methods](https://techdocs.akamai.com/linode-api/reference/get-payment-methods.md): Returns a paginated list of Payment Methods for this Account. **Permissions and scopes** To call this operation, you need permissions, based on the model you're using: - **Identity and access permissions**. Your user needs a role with these permissions. [Learn more](https://techdocs.akamai.com/cloud-computing/docs/identity-access-cm-available-roles). - Permissions: `list_payment_methods` - **OAuth scopes**. Your user needs these scopes assigned. [Learn more](https://techdocs.akamai.com/linode-api/reference/get-started#oauth). - Scopes: `account:read_only` **CLI** ```shell linode-cli payment-methods list ``` [Learn more](https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli) - [Get a payment method](https://techdocs.akamai.com/linode-api/reference/get-payment-method.md): View the details of the specified Payment Method. **Permissions and scopes** To call this operation, you need permissions, based on the model you're using: - **Identity and access permissions**. Your user needs a role with these permissions. [Learn more](https://techdocs.akamai.com/cloud-computing/docs/identity-access-cm-available-roles). - Permissions: `view_payment_method` - **OAuth scopes**. Your user needs these scopes assigned. [Learn more](https://techdocs.akamai.com/linode-api/reference/get-started#oauth). - Scopes: `account:read_only` **CLI** ```shell linode-cli payment-methods view 123 ``` [Learn more](https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli) - [Delete a payment method](https://techdocs.akamai.com/linode-api/reference/delete-payment-method.md): Deactivate the specified Payment Method. The default Payment Method can not be deleted. To add a new default Payment Method, run the [Add a payment method](ref:post-payment-method) operation. To designate an existing Payment Method as the default method, run the [Set a default payment method](ref:post-make-payment-method-default) operation. **Permissions and scopes** To call this operation, you need permissions, based on the model you're using: - **Identity and access permissions**. Your user needs a role with these permissions. [Learn more](https://techdocs.akamai.com/cloud-computing/docs/identity-access-cm-available-roles). - Permissions: `delete_payment_method` - **OAuth scopes**. Your user needs these scopes assigned. [Learn more](https://techdocs.akamai.com/linode-api/reference/get-started#oauth). - Scopes: `account:read_only` **CLI** ```shell linode-cli payment-methods delete 123 ``` [Learn more](https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli) - [Set a default payment method](https://techdocs.akamai.com/linode-api/reference/post-make-payment-method-default.md): Make the specified Payment Method the default method for automatically processing payments. Removes the default status from any other Payment Method. __Parent and child accounts__ In the context of the [parent and child accounts](https://techdocs.akamai.com/cloud-computing/docs/parent-and-child-accounts-for-akamai-partners) feature, this operation isn't available for child account users. **Permissions and scopes** To call this operation, you need permissions, based on the model you're using: - **Identity and access permissions**. Your user needs a role with these permissions. [Learn more](https://techdocs.akamai.com/cloud-computing/docs/identity-access-cm-available-roles). - Permissions: `set_default_payment_method` - **OAuth scopes**. Your user needs these scopes assigned. [Learn more](https://techdocs.akamai.com/linode-api/reference/get-started#oauth). - Scopes: `account:read_write` **CLI** ```shell linode-cli payment-methods default 123 ``` [Learn more](https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli) - [Add or edit a credit card](https://techdocs.akamai.com/linode-api/reference/post-credit-card.md): __Deprecated__ Please run [Add a payment method](ref:post-payment-method). Adds or edits a credit card to your account and sets it as the default payment method. **Permissions and scopes** To call this operation, you need permissions, based on the model you're using: - **OAuth scopes**. Your user needs these scopes assigned. [Learn more](https://techdocs.akamai.com/linode-api/reference/get-started#oauth). - Scopes: `account:read_write` - [Make a payment](https://techdocs.akamai.com/linode-api/reference/post-payment.md): Makes a payment to your account. - The requested amount is charged to the default payment method if no `payment_method_id` is specified. - A `payment_submitted` event is generated when a payment is successfully submitted. __Parent and child accounts__ In the context of the [parent and child accounts](https://techdocs.akamai.com/cloud-computing/docs/parent-and-child-accounts-for-akamai-partners) feature, this operation isn't available for child account users. **Permissions and scopes** To call this operation, you need permissions, based on the model you're using: - **Identity and access permissions**. Your user needs a role with these permissions. [Learn more](https://techdocs.akamai.com/cloud-computing/docs/identity-access-cm-available-roles). - Permissions: `make_billing_payment` - **OAuth scopes**. Your user needs these scopes assigned. [Learn more](https://techdocs.akamai.com/linode-api/reference/get-started#oauth). - Scopes: `account:read_write` **CLI** ```shell linode-cli account payment-create \ --usd 120.50 \ --payment_method_id 123 ``` [Learn more](https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli) - [List payments](https://techdocs.akamai.com/linode-api/reference/get-payments.md): Returns a paginated list of payments made on this Account. **Permissions and scopes** To call this operation, you need permissions, based on the model you're using: - **Identity and access permissions**. Your user needs a role with these permissions. [Learn more](https://techdocs.akamai.com/cloud-computing/docs/identity-access-cm-available-roles). - Permissions: `list_billing_payments` - **OAuth scopes**. Your user needs these scopes assigned. [Learn more](https://techdocs.akamai.com/linode-api/reference/get-started#oauth). - Scopes: `account:read_only` **CLI** ```shell linode-cli account payments-list ``` [Learn more](https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli) - [Stage a PayPal payment](https://techdocs.akamai.com/linode-api/reference/post-pay-pal-payment.md): __Deprecated__ This operation is disabled and no longer accessible. PayPal can be designated as a Payment Method for automated payments using the Cloud Manager. See [Manage Payment Methods](https://www.linode.com/docs/products/platform/billing/guides/payment-methods/). **Permissions and scopes** To call this operation, you need permissions, based on the model you're using: - **OAuth scopes**. Your user needs these scopes assigned. [Learn more](https://techdocs.akamai.com/linode-api/reference/get-started#oauth). - Scopes: `account:read_write` - [Execute a PayPal payment](https://techdocs.akamai.com/linode-api/reference/post-execute-pay-pal-payment.md): __Deprecated__ This operation is disabled and no longer accessible. PayPal can be designated as a Payment Method for automated payments using the Cloud Manager. See [Manage Payment Methods](https://www.linode.com/docs/products/platform/billing/guides/payment-methods/). **Permissions and scopes** To call this operation, you need permissions, based on the model you're using: - **OAuth scopes**. Your user needs these scopes assigned. [Learn more](https://techdocs.akamai.com/linode-api/reference/get-started#oauth). - Scopes: `account:read_write` - [Get a payment](https://techdocs.akamai.com/linode-api/reference/get-payment.md): Returns information about a specific Payment. **Permissions and scopes** To call this operation, you need permissions, based on the model you're using: - **Identity and access permissions**. Your user needs a role with these permissions. [Learn more](https://techdocs.akamai.com/cloud-computing/docs/identity-access-cm-available-roles). - Permissions: `view_billing_payment` - **OAuth scopes**. Your user needs these scopes assigned. [Learn more](https://techdocs.akamai.com/linode-api/reference/get-started#oauth). - Scopes: `account:read_only` **CLI** ```shell linode-cli account payment-view 123 ``` [Learn more](https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli) - [Add a promo credit](https://techdocs.akamai.com/linode-api/reference/post-promo-credit.md): Adds an expiring Promo Credit to your account. The following restrictions apply: - Your account needs to be less than 90 days old. - You can't already have a Promo Credit on your account. - The `promo_code` needs to be valid and unexpired. __Parent and child accounts__ In the context of the [parent and child accounts](https://techdocs.akamai.com/cloud-computing/docs/parent-and-child-accounts-for-akamai-partners) feature, this operation isn't available for child account users. **Permissions and scopes** To call this operation, you need permissions, based on the model you're using: - **Identity and access permissions**. Your user needs a role with these permissions. [Learn more](https://techdocs.akamai.com/cloud-computing/docs/identity-access-cm-available-roles). - Permissions: `create_promo_code` - **OAuth scopes**. Your user needs these scopes assigned. [Learn more](https://techdocs.akamai.com/linode-api/reference/get-started#oauth). - Scopes: `account:read_only` **CLI** ```shell linode-cli account \ promo-add \ --promo-code abcdefABCDEF1234567890 ``` [Learn more](https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli) - [Request a service transfer](https://techdocs.akamai.com/linode-api/reference/post-service-transfer.md): Creates a transfer request for one or more services you specify. A request can contain any of the eligible service types and any number of each service type. Currently, you can only transfer your Linode instances. **Create the service transfer** DNS records assigned to requested services _aren't_ transferred or updated. Ensure that you update any applicable DNS records or communicate them to the recipient before transfer. When creating a service transfer, consider these points: - Your account can't have a past due balance or other limitations. It also can't have any active terms of service violations. - On your account, you need to have access to any transferred service. - The service can't be assigned to another pending service transfer request or a request that's been [accepted](ref:post-accept-service-transfer), but is incomplete. - Linodes _can't_: - be assigned to a NodeBalancer, Firewall, VLAN, or Managed Service. - have a Reserved IPv4 address assigned to them. To transfer a Linode with a reserved IP, you must first convert the address to an ephemeral IP or unassign it. - have any attached Block Storage volumes. - have any shared IP addresses. - have any assigned `/32`, `/56`, `/64`, or `/116` IPv6 ranges. - have a [resource lock](ref:post-resource-lock) set. You need to unlock the Linode by deleting the lock. After you create a service transfer request, the email address assigned to your account will receive a message. The message also contains a transfer token you need to store, and instructions to complete the transfer. > 📘 > > A requested transfer expires 24 hours after creation. **Accept a service transfer** You [accept](ref:post-accept-service-transfer) a transfer using a separate operation. Once you do, the requested services are moved to the target account. Your Akamai Cloud services aren't interrupted due to a transfer. Backups for Linode instances are transferred as well. A transfer can take up to three hours to complete once accepted. Once the transfer completes, billing for transferred services ends for your account, and begins for the account that accepted the request. **Permissions and scopes** To call this operation, you need permissions, based on the model you're using: - **Identity and access permissions**. Your user needs a role with these permissions. [Learn more](https://techdocs.akamai.com/cloud-computing/docs/identity-access-cm-available-roles). - Permissions: `create_service_transfer` - **OAuth scopes**. Your user needs these scopes assigned. [Learn more](https://techdocs.akamai.com/linode-api/reference/get-started#oauth). - Scopes: `account:read_write` **CLI** ```shell linode-cli service-transfers \ create \ --entities.linodes 111 \ --entities.linodes 222 ``` [Learn more](https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli) - [List service transfers](https://techdocs.akamai.com/linode-api/reference/get-service-transfers.md): Returns all [requested](ref:post-service-transfer) and [accepted](ref:post-accept-service-transfer) service transfers for this account, regardless of the user who requested or accepted the transfer. **Permissions and scopes** To call this operation, you need permissions, based on the model you're using: - **Identity and access permissions**. Your user needs a role with these permissions. [Learn more](https://techdocs.akamai.com/cloud-computing/docs/identity-access-cm-available-roles). - Permissions: `list_service_transfers` - **OAuth scopes**. Your user needs these scopes assigned. [Learn more](https://techdocs.akamai.com/linode-api/reference/get-started#oauth). - Scopes: `account:read_only` **CLI** ```shell linode-cli service-transfers \ list ``` [Learn more](https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli) - [Get a service transfer request](https://techdocs.akamai.com/linode-api/reference/get-service-transfer.md): Returns details for the service transfer for the provided `token`. - After a transfer has been [accepted](ref:post-accept-service-transfer), it can only be viewed by users on the accounts that [requested](ref:post-service-transfer) and [accepted](ref:post-accept-service-transfer) the transfer and have the corresponding permissions. - If [canceled](ref:delete-service-transfer) or expired, only users of the account that requested the transfer can view it and have the required permission. **Permissions and scopes** To call this operation, you need permissions, based on the model you're using: - **Identity and access permissions**. Your user needs a role with these permissions. [Learn more](https://techdocs.akamai.com/cloud-computing/docs/identity-access-cm-available-roles). - Permissions: `view_service_transfer` - **OAuth scopes**. Your user needs these scopes assigned. [Learn more](https://techdocs.akamai.com/linode-api/reference/get-started#oauth). - Scopes: `account:read_only` **CLI** ```shell linode-cli service-transfers \ view 123E4567-E89B-12D3-A456-426614174000 ``` [Learn more](https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli) - [Cancel a service transfer](https://techdocs.akamai.com/linode-api/reference/delete-service-transfer.md): Cancels the service transfer for the provided `token`. These points apply to canceling a service transfer: - An cancellation notification is sent to the email address that's assigned to the account that requested the transfer. - Once canceled, the transfer can't be accepted or acted on in any way. If you cancel by mistake, you need to [create](ref:post-service-transfer) a new service transfer. - You can't cancel a service transfer if it's expired or it's been [accepted](ref:post-accept-service-transfer). **Permissions and scopes** To call this operation, you need permissions, based on the model you're using: - **Identity and access permissions**. Your user needs a role with these permissions. [Learn more](https://techdocs.akamai.com/cloud-computing/docs/identity-access-cm-available-roles). - Permissions: `cancel_service_transfer` - **OAuth scopes**. Your user needs these scopes assigned. [Learn more](https://techdocs.akamai.com/linode-api/reference/get-started#oauth). - Scopes: `account:read_write` **CLI** ```shell linode-cli service-transfers \ cancel 123E4567-E89B-12D3-A456-426614174000 ``` [Learn more](https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli) - [Accept a service transfer](https://techdocs.akamai.com/linode-api/reference/post-accept-service-transfer.md): After you [request a service transfer](ref:post-service-transfer) to another account, use this operation along with the `token` from the transfer request email, to accept it for the target account. Currently, you can only transfer your Linode instances. After you accept a transfer, the email address assigned to your account will receive a message. The same message is sent to the email address assigned to the account that requested the transfer. Once the transfer completes, billing for transferred services ends for the account that made the request, and begins for your account. There are several conditions that need to be met to accept a transfer request: - Only transfers with a `pending` status can be accepted. - To accept a transfer, your account needs to have a registered payment method, and it can't have a past due balance or other limitations. It also can't have any active terms of service violations. - Any transferred service needs to be owned by the account that requested the transfer. - Linodes _can't_: - be assigned to a NodeBalancer, Firewall, VLAN, or Managed Service. - have a Reserved IPv4 address assigned to them. The initiating account must convert the address to an ephemeral IP or unassign it before the transfer can be completed. - have any attached Block Storage volumes. - have any shared IP addresses. - have any assigned /56, /64, or /116 IPv6 ranges. - have a [resource lock](ref:post-resource-lock) set. You need to unlock the Linode by deleting the lock. > 📘 > > A requested transfer expires 24 hours after creation. You need to meet all of these conditions before this expiration to allow the transfer. Otherwise, you need to [request a service transfer](ref:post-service-transfer) again. **Permissions and scopes** To call this operation, you need permissions, based on the model you're using: - **Identity and access permissions**. Your user needs a role with these permissions. [Learn more](https://techdocs.akamai.com/cloud-computing/docs/identity-access-cm-available-roles). - Permissions: `accept_service_transfer` - **OAuth scopes**. Your user needs these scopes assigned. [Learn more](https://techdocs.akamai.com/linode-api/reference/get-started#oauth). - Scopes: `account:read_write` **CLI** ```shell linode-cli service-transfers \ accept 123E4567-E89B-12D3-A456-426614174000 ``` [Learn more](https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli) - [Create a user](https://techdocs.akamai.com/linode-api/reference/post-user.md): Creates a user on your account. You determine the new user's account access by setting it to restricted or unrestricted: - **Unrestricted access**. These users can access everything on an account. - **Restricted access**. These users can only access entities or perform actions they've been given specific grants to. After completion, the API sends a confirmation message containing password creation and login instructions to the user's `email` address. > 🚧 RBAC Identity and Access > > If Identity and Access is enabled on your account, the *restricted* user is assigned the `account_admin` role and for *restricted* users you need follow this operation with [assigning roles to the user](ref:put-iam-users-role-permissions). To learn more, see [Identity and Access for Akamai Cloud](https://techdocs.akamai.com/cloud-computing/docs/identity-and-access-cm). **Permissions and scopes** To call this operation, you need permissions, based on the model you're using: - **Identity and access permissions**. Your user needs a role with these permissions. [Learn more](https://techdocs.akamai.com/cloud-computing/docs/identity-access-cm-available-roles). - Permissions: `create_user` - **OAuth scopes**. Your user needs these scopes assigned. [Learn more](https://techdocs.akamai.com/linode-api/reference/get-started#oauth). - Scopes: `account:read_write` **CLI** ```shell linode-cli users create \ --username example_user \ --email example_user@linode.com \ --restricted true ``` [Learn more](https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli) - [List users](https://techdocs.akamai.com/linode-api/reference/get-users.md): Returns a paginated list of all users on your account. A user can access all or part of an account based on their role assignment: - **Unrestricted access**. These users can access everything on an account. - **Restricted access**. These users can only access entities or perform actions they've been given specific grants to. > 🚧 RBAC Identity and Access > > If Identity and Access is enabled on your account, the *restricted* users have the `account_admin` role and *restricted* users have [specific roles assigned to them](ref:get-iam-users-role-permissions). To learn more, see [Identity and Access for Akamai Cloud](https://techdocs.akamai.com/cloud-computing/docs/identity-and-access-cm). tabs: - syntax: | linode-cli users list title: CLI url: https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli **Permissions and scopes** To call this operation, you need permissions, based on the model you're using: - **Identity and access permissions**. Your user needs a role with these permissions. [Learn more](https://techdocs.akamai.com/cloud-computing/docs/identity-access-cm-available-roles). - Permissions: `view_user` - **OAuth scopes**. Your user needs these scopes assigned. [Learn more](https://techdocs.akamai.com/linode-api/reference/get-started#oauth). - Scopes: `account:read_only` - [Get a user](https://techdocs.akamai.com/linode-api/reference/get-user.md): Returns information about a single user on your account. **Permissions and scopes** To call this operation, you need permissions, based on the model you're using: - **Identity and access permissions**. Your user needs a role with these permissions. [Learn more](https://techdocs.akamai.com/cloud-computing/docs/identity-access-cm-available-roles). - Permissions: `view_user` - **OAuth scopes**. Your user needs these scopes assigned. [Learn more](https://techdocs.akamai.com/linode-api/reference/get-started#oauth). - Scopes: `account:read_only` **CLI** ```shell linode-cli users view example_user ``` [Learn more](https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli) - [Update a user](https://techdocs.akamai.com/linode-api/reference/put-user.md): Update information about a user on your account, including its restricted status. When setting a user to `restricted`, the API sets no grants for it. You need to set grants so that user can access things on the account. > 🚧 RBAC Identity and Access > > If Identity and Access is enabled on your account, the *restricted* users have the `account_admin` role and *restricted* users have specific roles assigned to them. To update the role assignment, run the [Update a user's access level](ref:put-iam-users-role-permissions) operation instead. To learn more, see [Identity and Access for Akamai Cloud](https://techdocs.akamai.com/cloud-computing/docs/identity-and-access-cm). __Parent and child accounts__ In the context of the [parent and child accounts](https://techdocs.akamai.com/cloud-computing/docs/parent-and-child-accounts-for-akamai-partners) feature, on a child account, you can't edit the `username` or `email` values for delegate users. **Permissions and scopes** To call this operation, you need permissions, based on the model you're using: - **Identity and access permissions**. Your user needs a role with these permissions. [Learn more](https://techdocs.akamai.com/cloud-computing/docs/identity-access-cm-available-roles). - Permissions: `update_user` - **OAuth scopes**. Your user needs these scopes assigned. [Learn more](https://techdocs.akamai.com/linode-api/reference/get-started#oauth). - Scopes: `account:read_write` **CLI** ```shell linode-cli users update example_user \ --username example_user \ --email example@linode.com \ --restricted true ``` [Learn more](https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli) - [Delete a user](https://techdocs.akamai.com/linode-api/reference/delete-user.md): Deletes a user. The API immediately logs the user out and removes their access to all Akamai Cloud services. __Parent and child accounts__ In the context of the [parent and child accounts](https://techdocs.akamai.com/cloud-computing/docs/parent-and-child-accounts-for-akamai-partners) feature, you can't delete a user with the `delegate` user type on a child account. **Permissions and scopes** To call this operation, you need permissions, based on the model you're using: - **Identity and access permissions**. Your user needs a role with these permissions. [Learn more](https://techdocs.akamai.com/cloud-computing/docs/identity-access-cm-available-roles). - Permissions: `delete_user` - **OAuth scopes**. Your user needs these scopes assigned. [Learn more](https://techdocs.akamai.com/linode-api/reference/get-started#oauth). - Scopes: `account:read_write` **CLI** ```shell linode-cli users delete example_user ``` [Learn more](https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli) - [List a user's grants](https://techdocs.akamai.com/linode-api/reference/get-user-grants.md): __Deprecated__ Returns the full grants structure for an account username you specify. This includes all entities on the account, and the level of access this user has to each of them. This doesn't apply to the account owner or the current authenticated user. You can run the [List grants](ref:get-profile-grants) operation to view those grants. > 🚧 RBAC Identity and Access > > Grants are now replaced with RBAC Identity and Access. Use the [Get a user's access level](ref:get-iam-users-role-permissions) operation instead. To learn more, see [Identity and Access for Akamai Cloud](https://techdocs.akamai.com/cloud-computing/docs/identity-and-access-cm). **Permissions and scopes** To call this operation, you need permissions, based on the model you're using: - **Identity and access permissions**. Your user needs a role with these permissions. [Learn more](https://techdocs.akamai.com/cloud-computing/docs/identity-access-cm-available-roles). - Permissions: `list_user_grants` - **OAuth scopes**. Your user needs these scopes assigned. [Learn more](https://techdocs.akamai.com/linode-api/reference/get-started#oauth). - Scopes: `account:read_only` - [Update a user's grants](https://techdocs.akamai.com/linode-api/reference/put-user-grants.md): __Deprecated__ Update the grants for a [restricted](ref:post-user) user. This can be used to give a user access to new entities or actions, or take access away. Omit a grant object from the request to keep its current setting. > 🚧 RBAC Identity and Access > > Grants are now replaced with RBAC Identity and Access. Use the [Update a user's access level](ref:put-iam-users-role-permissions) operation instead. To learn more, see [Identity and Access for Akamai Cloud](https://techdocs.akamai.com/cloud-computing/docs/identity-and-access-cm). **Permissions and scopes** To call this operation, you need permissions, based on the model you're using: - **Identity and access permissions**. Your user needs a role with these permissions. [Learn more](https://techdocs.akamai.com/cloud-computing/docs/identity-access-cm-available-roles). - Permissions: `update_user_grants` - **OAuth scopes**. Your user needs these scopes assigned. [Learn more](https://techdocs.akamai.com/linode-api/reference/get-started#oauth). - Scopes: `account:read_write` - [Get an OAuth client's thumbnail](https://techdocs.akamai.com/linode-api/reference/get-client-thumbnail.md): Returns the PNG thumbnail for this OAuth client. This is a publicly viewable operation, and you can access it without authentication. - [Update an OAuth client's thumbnail](https://techdocs.akamai.com/linode-api/reference/put-client-thumbnail.md): Upload a thumbnail for a client you own. You need to upload a PNG image file that the Linode API returns when the thumbnail is retrieved. This image is publicly viewable. **Permissions and scopes** To call this operation, you need permissions, based on the model you're using: - **Identity and access permissions**. Your user needs a role with these permissions. [Learn more](https://techdocs.akamai.com/cloud-computing/docs/identity-access-cm-available-roles). - Permissions: `update_oauth_client_thumbnail` - **OAuth scopes**. Your user needs these scopes assigned. [Learn more](https://techdocs.akamai.com/linode-api/reference/get-started#oauth). - Scopes: `account:read_write` - [List Beta programs](https://techdocs.akamai.com/linode-api/reference/get-beta-programs.md): Display all active Beta programs. This operation can only be accessed by account [users](ref:get-users) with _unrestricted_ access. Talk to your local account administrator about access management. **CLI** ```shell linode-cli betas list ``` [Learn more](https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli) - [Get a Beta program](https://techdocs.akamai.com/linode-api/reference/get-beta-program.md): Display information about a Beta program. You can use it to access inactive and active Beta programs. This operation can only be accessed by account [users](ref:get-users) with _unrestricted_ access. Talk to your local account administrator about access management. **CLI** ```shell linode-cli betas view $betaId ``` [Learn more](https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli) - [List Managed Databases engines](https://techdocs.akamai.com/linode-api/reference/get-databases-engines.md): Display all available Managed Databases engine types and versions. Use an engine's `id` to create a new Managed Databases instance. **Permissions and scopes** To call this operation, you need the following: - **Identity and access permissions**. Your user needs these roles assigned. [Learn more](https://techdocs.akamai.com/cloud-computing/docs/identity-access-cm-available-roles). - Roles: `database_viewer` **CLI** ```shell linode-cli databases engines ``` [Learn more](https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli) - [Get a Managed Databases engine](https://techdocs.akamai.com/linode-api/reference/get-databases-engine.md): Display information for a single Managed Databases engine type and version. Run the [List Managed Databases engines](ref:get-databases-engines) operation and store the `id` for the applicable database engine. **Permissions and scopes** To call this operation, you need the following: - **Identity and access permissions**. Your user needs these roles assigned. [Learn more](https://techdocs.akamai.com/cloud-computing/docs/identity-access-cm-available-roles). - Roles: `database_viewer` **CLI** ```shell linode-cli databases engine-view ``` [Learn more](https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli) - [List Managed Databases](https://techdocs.akamai.com/linode-api/reference/get-databases-instances.md): Display information for all Managed Databases accessible to your user, regardless of engine type. > 👍 > > For more detailed information, you can list Managed Databases, based on the `engine`, [MySQL](ref:get-databases-mysql-instances) or [PostgreSQL](ref:get-databases-postgre-sql-instances). **Permissions and scopes** To call this operation, you need the following: - **Identity and access permissions**. Your user needs these roles assigned. [Learn more](https://techdocs.akamai.com/cloud-computing/docs/identity-access-cm-available-roles). - Roles: `database_viewer` - **OAuth scopes**. Your user needs these scopes assigned. [Learn more](https://techdocs.akamai.com/linode-api/reference/get-started#oauth). - Scopes: `databases:read_only` **CLI** ```shell linode-cli databases list ``` [Learn more](https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli) - [List Managed Databases types](https://techdocs.akamai.com/linode-api/reference/get-databases-types.md): Display all Managed Databases node types. The type and number of nodes determine the resources and price of a Managed Databases instance. Each database can have one node type. With a high availability database, all nodes are deployed according to the chosen type. **Permissions and scopes** To call this operation, you need the following: - **Identity and access permissions**. Your user needs these roles assigned. [Learn more](https://techdocs.akamai.com/cloud-computing/docs/identity-access-cm-available-roles). - Roles: `database_viewer` **CLI** ```shell linode-cli databases types ``` [Learn more](https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli) - [Get a Managed Databases type](https://techdocs.akamai.com/linode-api/reference/get-databases-type.md): Display the details of a single Managed Databases node type. The type and number of nodes determine the resources and price of a Managed Databases instance. Run the [List Managed Databases type](ref:get-databases-types) operation and store the `id` for the applicable database node type. **Permissions and scopes** To call this operation, you need the following: - **Identity and access permissions**. Your user needs these roles assigned. [Learn more](https://techdocs.akamai.com/cloud-computing/docs/identity-access-cm-available-roles). - Roles: `database_viewer` **CLI** ```shell linode-cli databases type-view ``` [Learn more](https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli) - [Create or restore a MySQL Managed Database](https://techdocs.akamai.com/linode-api/reference/post-databases-mysql-instances.md): **Provision a MySQL Managed Database** Use this operation to create a new MySQL Managed Database. - New instances can take 10 to 15 minutes to deploy. - When you create a new MySQL Managed Database, our partner [Aiven](https://aiven.io/docs/platform/concepts/cloud-security#data-encryption) automatically enables disk encryption on each cluster. - All Managed Databases include automatic, daily backups. Up to seven backups are automatically stored for each Managed Database, providing restore points for each day of the past week. - All Managed Databases include automatic updates, which apply security patches to the underlying operating system of the MySQL Managed Database. Configure the maintenance window for these updates with the [Update a managed MySQL database](ref:put-databases-mysql-instance) operation. - If your database cluster is configured with a single node, downtime occurs during maintenance updates. You should adjust the window to match a time that's the least disruptive to your application and users. Also consider upgrading to a [high availability](https://techdocs.akamai.com/cloud-computing/docs/aiven-database-clusters#high-availability) plan to avoid any maintenance downtime. - Major upgrades are optional until the service reaches end of service, and can be done in place. - A successful request triggers a `database_create` [event](ref:get-events). **Beta** **Virtual Private Cloud (VPC) support** You can create a MySQL Managed Database in a VPC using the `private_network` object in the request. Talk to your Akamai account team for more details. > 📘 > > Currently, VPC subnets associated with Managed Database instances don't automatically block outbound connections outside the subnet. To limit network exposure, you should configure Cloud Firewall rules to explicitly deny outbound connections beyond the intended subnet. For more details on configuring rules, see the [Cloud Firewall](https://techdocs.akamai.com/cloud-computing/docs/cloud-firewall) documentation. **Restore a MySQL Managed Database** Include the `fork` object in the request to target a backed-up database. > 📘 > > Restoring from a backup creates a second running cluster, which incurs billing. Delete the first cluster after the restore is complete, to avoid this billing. > 👍 There's a tutorial > > We offer an example API workflow you can follow to [restore a Managed Database backup](ref:restore-a-managed-database-backup). **Permissions and scopes** To call this operation, you need the following: - **Identity and access permissions**. Your user needs these roles assigned. [Learn more](https://techdocs.akamai.com/cloud-computing/docs/identity-access-cm-available-roles). - Roles: `account_database_creator` - **OAuth scopes**. Your user needs these scopes assigned. [Learn more](https://techdocs.akamai.com/linode-api/reference/get-started#oauth). - Scopes: `databases:read_write` **CLI** ```shell linode-cli databases mysql-create \ --label example-db1 \ --region us-east \ --type g6-dedicated-2 \ --cluster_size 3 \ --engine mysql/8.0.26 \ --engine_config.binlog_retention_period 600 \ --engine_config.mysql.connect_timeout 10 \ --engine_config.mysql.default_time_zone +03:00 \ --ssl_connection true \ --allow_list 203.0.113.1 \ --allow_list 192.0.1.0/24 ``` [Learn more](https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli) - [List MySQL Managed Databases](https://techdocs.akamai.com/linode-api/reference/get-databases-mysql-instances.md): Display all accessible MySQL Managed Databases. **Permissions and scopes** To call this operation, you need the following: - **Identity and access permissions**. Your user needs these roles assigned. [Learn more](https://techdocs.akamai.com/cloud-computing/docs/identity-access-cm-available-roles). - Roles: `database_viewer` - **OAuth scopes**. Your user needs these scopes assigned. [Learn more](https://techdocs.akamai.com/linode-api/reference/get-started#oauth). - Scopes: `databases:read_only` **CLI** ```shell linode-cli databases mysql-list ``` [Learn more](https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli) - [Get a MySQL Managed Database](https://techdocs.akamai.com/linode-api/reference/get-databases-mysql-instance.md): Display information for a single, accessible MySQL Managed Database. **Permissions and scopes** To call this operation, you need the following: - **Identity and access permissions**. Your user needs these roles assigned. [Learn more](https://techdocs.akamai.com/cloud-computing/docs/identity-access-cm-available-roles). - Roles: `database_viewer` - **OAuth scopes**. Your user needs these scopes assigned. [Learn more](https://techdocs.akamai.com/linode-api/reference/get-started#oauth). - Scopes: `databases:read_only` **CLI** ```shell linode-cli databases mysql-view 123 ``` [Learn more](https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli) - [Update a MySQL Managed Database](https://techdocs.akamai.com/linode-api/reference/put-databases-mysql-instance.md): Make changes to an existing MySQL Managed Database. - The database's status needs to be `active`. - New values set in the `allow_list` overwrite existing values. To keep existing values, run the [List MySQL Managed Databases](ref:get-databases-mysql-instances) operation, store the `allow_list` addresses from the response, and include them with any new addresses in this operation. - Updates to your `allow_list` may take a short time to complete, making this operation inappropriate for rapid successive updates. - Also allows resizing the database cluster to a larger one. Clusters can't be resized to smaller plans. - All Managed Databases include automatic updates, which apply security patches to the underlying operating system of the Managed MySQL Database. Use the `updates` object in this operation to modify the maintenance window for these updates. - If your database cluster is configured with a single node, downtime occurs during maintenance updates. Use the `updates` object to adjust the window to match a time that's the least disruptive to your application and users. Also consider upgrading to a [high availability](https://techdocs.akamai.com/cloud-computing/docs/aiven-database-clusters#high-availability) plan to avoid any maintenance downtime. - Major upgrades are optional until the service reaches end of service, and can be done in place. - You can't update `engine_config` advanced parameter settings for a suspended database. You'll need to [resume](ref:resume-databases-mysql-instance) it first. - A successful request triggers a `database_update` [event](ref:get-events). - **Beta**. You can update an existing MySQL Managed Database to move it to a Virtual Private Cloud (VPC) using the `private_network` object in the request. This support is in beta. Talk to your Akamai account team for more details. > 📘 > > Currently, VPC subnets associated with Managed Database instances don't automatically block outbound connections outside the subnet. To limit network exposure, you should configure Cloud Firewall rules to explicitly deny outbound connections beyond the intended subnet. For more details on configuring rules, see the [Cloud Firewall](https://techdocs.akamai.com/cloud-computing/docs/cloud-firewall) documentation. **Permissions and scopes** To call this operation, you need the following: - **Identity and access permissions**. Your user needs these roles assigned. [Learn more](https://techdocs.akamai.com/cloud-computing/docs/identity-access-cm-available-roles). - Roles: `database_admin` - **OAuth scopes**. Your user needs these scopes assigned. [Learn more](https://techdocs.akamai.com/linode-api/reference/get-started#oauth). - Scopes: `databases:read_write` **CLI** ```shell linode-cli databases mysql-update 123 \ --label example-db \ --allow_list 203.0.113.1 \ --allow_list 192.0.1.0/24 \ --type g6-standard-1 \ --engine_config.binlog_retention_period 600 \ --engine_config.mysql.connect_timeout 10 \ --engine_config.mysql.default_time_zone +03:00 \ --updates.frequency weekly \ --updates.duration 3 \ --updates.hour_of_day 12 \ --updates.day_of_week 4 \ ``` [Learn more](https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli) - [Patch a MySQL Managed Database](https://techdocs.akamai.com/linode-api/reference/post-databases-mysql-instance-patch.md): Apply security patches and updates to the underlying operating system of the MySQL Managed Database. This function runs during regular maintenance windows, which you can configure with the [Update a managed MySQL database](ref:put-databases-mysql-instance) operation. - The database's status needs to be `active`. - If your database cluster is configured with a single node, downtime occurs during maintenance updates. Consider upgrading to a [high availability](https://techdocs.akamai.com/cloud-computing/docs/aiven-database-clusters#high-availability) plan to avoid any maintenance downtime. - Major upgrades are optional until the service reaches end of service, and can be done in place. - A successful request triggers a `database_upgrade` [event](ref:get-events). **Permissions and scopes** To call this operation, you need the following: - **Identity and access permissions**. Your user needs these roles assigned. [Learn more](https://techdocs.akamai.com/cloud-computing/docs/identity-access-cm-available-roles). - Roles: `database_admin` - **OAuth scopes**. Your user needs these scopes assigned. [Learn more](https://techdocs.akamai.com/linode-api/reference/get-started#oauth). - Scopes: `databases:read_write` **CLI** ```shell linode-cli databases mysql-patch 123 ``` [Learn more](https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli) - [Suspend a MySQL Managed Database](https://techdocs.akamai.com/linode-api/reference/suspend-databases-mysql-instance.md): Suspend a MySQL Managed Database from your account, releasing idle resources and keeping only necessary data. All service data is lost if there are no backups available. This halts billing for the cluster. - The database's status needs to be `active`. - Akamai deletes suspended clusters after 180 days. - A successful request triggers a `database_update` [event](ref:get-events). **Permissions and scopes** To call this operation, you need the following: - **Identity and access permissions**. Your user needs these roles assigned. [Learn more](https://techdocs.akamai.com/cloud-computing/docs/identity-access-cm-available-roles). - Roles: `database_admin` - **OAuth scopes**. Your user needs these scopes assigned. [Learn more](https://techdocs.akamai.com/linode-api/reference/get-started#oauth). - Scopes: `databases:read_write` **CLI** ```shell linode-cli databases mysql-suspend 123 ``` [Learn more](https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli) - [Resume a MySQL Managed Database](https://techdocs.akamai.com/linode-api/reference/resume-databases-mysql-instance.md): Resume a suspended MySQL Managed Database from your account. This resumes billing for the cluster. - The database's status needs to be `suspended`. - A successful request triggers a `database_resume` [event](ref:get-events). **Permissions and scopes** To call this operation, you need the following: - **Identity and access permissions**. Your user needs these roles assigned. [Learn more](https://techdocs.akamai.com/cloud-computing/docs/identity-access-cm-available-roles). - Roles: `database_admin` - **OAuth scopes**. Your user needs these scopes assigned. [Learn more](https://techdocs.akamai.com/linode-api/reference/get-started#oauth). - Scopes: `databases:read_write` **CLI** ```shell linode-cli databases mysql-resume 123 ``` [Learn more](https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli) - [Delete a MySQL Managed Database](https://techdocs.akamai.com/linode-api/reference/delete-databases-mysql-instance.md): Deletes a MySQL Managed Database from your account. **Permissions and scopes** To call this operation, you need the following: - **Identity and access permissions**. Your user needs these roles assigned. [Learn more](https://techdocs.akamai.com/cloud-computing/docs/identity-access-cm-available-roles). - Roles: `database_admin` - **OAuth scopes**. Your user needs these scopes assigned. [Learn more](https://techdocs.akamai.com/linode-api/reference/get-started#oauth). - Scopes: `databases:read_write` **CLI** ```shell linode-cli databases mysql-delete 123 ``` [Learn more](https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli) - [List MySQL Managed Database advanced parameters](https://techdocs.akamai.com/linode-api/reference/get-databases-mysql-config.md): All advanced parameters you can apply to a MySQL Managed Database, via our partner [Aiven](https://aiven.io/docs/products/mysql/reference/advanced-params). > 📘 > > Aiven may offer other parameters, but Akamai Managed Databases only supports the ones listed in this operation. **Permissions and scopes** To call this operation, you need the following: - **Identity and access permissions**. Your user needs these roles assigned. [Learn more](https://techdocs.akamai.com/cloud-computing/docs/identity-access-cm-available-roles). - Roles: `database_viewer` - **OAuth scopes**. Your user needs these scopes assigned. [Learn more](https://techdocs.akamai.com/linode-api/reference/get-started#oauth). - Scopes: `databases:read_only` **CLI** ```shell linode-cli databases mysql-config ``` [Learn more](https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli) - [Get a MySQL Managed Database SSL certificate](https://techdocs.akamai.com/linode-api/reference/get-databases-mysql-instance-ssl.md): Display the SSL CA certificate for an accessible MySQL Managed Database. The database's status needs to be `active`. **Permissions and scopes** To call this operation, you need the following: - **Identity and access permissions**. Your user needs these roles assigned. [Learn more](https://techdocs.akamai.com/cloud-computing/docs/identity-access-cm-available-roles). - Roles: `database_viewer` - **OAuth scopes**. Your user needs these scopes assigned. [Learn more](https://techdocs.akamai.com/linode-api/reference/get-started#oauth). - Scopes: `databases:read_only` **CLI** ```shell linode-cli databases mysql-ssl-cert 123 ``` [Learn more](https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli) - [Get MySQL Managed Database credentials](https://techdocs.akamai.com/linode-api/reference/get-databases-mysql-instance-credentials.md): Display the root username and password for an accessible MySQL Managed Database. The database's status needs to be `active`. **Permissions and scopes** To call this operation, you need the following: - **Identity and access permissions**. Your user needs these roles assigned. [Learn more](https://techdocs.akamai.com/cloud-computing/docs/identity-access-cm-available-roles). - Roles: `database_viewer` - **OAuth scopes**. Your user needs these scopes assigned. [Learn more](https://techdocs.akamai.com/linode-api/reference/get-started#oauth). - Scopes: `databases:read_only` **CLI** ```shell linode-cli databases mysql-creds-view 123 ``` [Learn more](https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli) - [Reset MySQL Managed Database credentials](https://techdocs.akamai.com/linode-api/reference/post-databases-mysql-instance-credentials-reset.md): Reset the root password for a MySQL Managed Database. A new root password is randomly generated and accessible with the [Get MySQL Managed Database credentials](ref:get-databases-mysql-instance-credentials) operation. - The database's status needs to be `active`. - It may take several seconds for credentials to reset. **Permissions and scopes** To call this operation, you need the following: - **Identity and access permissions**. Your user needs these roles assigned. [Learn more](https://techdocs.akamai.com/cloud-computing/docs/identity-access-cm-available-roles). - Roles: `database_admin` - **OAuth scopes**. Your user needs these scopes assigned. [Learn more](https://techdocs.akamai.com/linode-api/reference/get-started#oauth). - Scopes: `databases:read_write` **CLI** ```shell linode-cli databases mysql-creds-reset 123 ``` [Learn more](https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli) - [Create or restore a PostgreSQL Managed Database](https://techdocs.akamai.com/linode-api/reference/post-databases-postgre-sql-instances.md): **Provision a PostgreSQL Managed Database** Use this operation to create a new PostgreSQL Managed Database. - New instances can take 10 to 15 minutes to deploy. - When you create a new PostgreSQL Managed Database, our partner [Aiven](https://aiven.io/docs/platform/concepts/cloud-security#data-encryption) automatically enables disk encryption on each cluster. - All Managed Databases include automatic, daily backups. Up to seven backups are automatically stored for each Managed Database, providing restore points for each day of the past week. - All Managed Databases include automatic updates, which apply security patches to the underlying operating system of the PostgreSQL Managed Database. Configure the maintenance window for these updates with the [Update a managed PostgreSQL database](ref:put-databases-postgre-sql-instance) operation. - If your database cluster is configured with a single node, downtime occurs during maintenance updates. Adjust the window to match a time that's the least disruptive to your application and users. Also consider upgrading to a [high availability](https://techdocs.akamai.com/cloud-computing/docs/aiven-database-clusters#high-availability) plan to avoid any maintenance downtime. - Major upgrades are optional until the service reaches end of service, and can be done in place. - A successful request triggers a `database_create` [event](ref:get-events). **Beta** **Virtual Private Cloud (VPC) support** You can create a PostgreSQL Managed Database in a VPC using the `private_network` object in the request. Talk to your Akamai account team for more details. > 📘 > > Currently, VPC subnets associated with Managed Database instances don't automatically block outbound connections outside the subnet. To limit network exposure, you should configure Cloud Firewall rules to explicitly deny outbound connections beyond the intended subnet. For more details on configuring rules, see the [Cloud Firewall](https://techdocs.akamai.com/cloud-computing/docs/cloud-firewall) documentation. **Restore a PostgreSQL Managed Database** Include the `fork` object in the request to target a backed-up database. > 📘 > > Restoring from a backup creates a second running cluster, which incurs billing. Delete the first cluster after the restore is complete, to avoid this billing. > 👍 There's a tutorial > > We offer an example API workflow you can follow to [restore a Managed Database backup](ref:restore-a-managed-database-backup). **Permissions and scopes** To call this operation, you need the following: - **Identity and access permissions**. Your user needs these roles assigned. [Learn more](https://techdocs.akamai.com/cloud-computing/docs/identity-access-cm-available-roles). - Roles: `account_database_creator` - **OAuth scopes**. Your user needs these scopes assigned. [Learn more](https://techdocs.akamai.com/linode-api/reference/get-started#oauth). - Scopes: `databases:read_write` **CLI** ```shell linode-cli databases postgresql-create \ --label example-db \ --region us-east \ --type g6-dedicated-2 \ --cluster_size 3 \ --engine postgresql/13.2 \ --engine_config.shared_buffers_percentage 41.5 \ --engine_config.pg.autovacuum_analyze_scale_factor 0.0 \ --engine_config.pg.autovacuum_vacuum_cost_delay 60 \ --engine_config.pg.pg_partman_bgw.interval 3600 \ --engine_config.pg.pg_partman_bgw.role myrolename \ --engine_config.pglookout.max_failover_replication_time_lag 60 \ --ssl_connection true \ --allow_list 203.0.113.1 \ --allow_list 192.0.1.0/24 ``` [Learn more](https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli) - [List PostgreSQL Managed Databases](https://techdocs.akamai.com/linode-api/reference/get-databases-postgre-sql-instances.md): Display all accessible PostgreSQL Managed Databases. **Permissions and scopes** To call this operation, you need the following: - **Identity and access permissions**. Your user needs these roles assigned. [Learn more](https://techdocs.akamai.com/cloud-computing/docs/identity-access-cm-available-roles). - Roles: `database_viewer` - **OAuth scopes**. Your user needs these scopes assigned. [Learn more](https://techdocs.akamai.com/linode-api/reference/get-started#oauth). - Scopes: `databases:read_only` **CLI** ```shell linode-cli databases postgresql-list ``` [Learn more](https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli) - [Get a PostgreSQL Managed Database](https://techdocs.akamai.com/linode-api/reference/get-databases-postgre-sql-instance.md): Display information for a single, accessible PostgreSQL Managed Database. **Permissions and scopes** To call this operation, you need the following: - **Identity and access permissions**. Your user needs these roles assigned. [Learn more](https://techdocs.akamai.com/cloud-computing/docs/identity-access-cm-available-roles). - Roles: `database_viewer` - **OAuth scopes**. Your user needs these scopes assigned. [Learn more](https://techdocs.akamai.com/linode-api/reference/get-started#oauth). - Scopes: `databases:read_only` **CLI** ```shell linode-cli databases postgresql-view 123 ``` [Learn more](https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli) - [Update a PostgreSQL Managed Database](https://techdocs.akamai.com/linode-api/reference/put-databases-postgre-sql-instance.md): Make changes to an existing PostgreSQL Managed Database. - The database's status needs to be `active`. - New values set in the `allow_list` overwrite existing values. To keep existing values, run the [List PostgreSQL Managed Databases](ref:get-databases-postgre-sql-instances) operation, store the `allow_list` addresses from the response, and include them with any new addresses in this operation. - Updates to your `allow_list` may take a short period of time to complete, making this operation inappropriate for rapid successive updates. - Also allows resizing the database cluster to a larger one. Clusters can't be resized to smaller plans. - All Managed Databases include automatic updates, which apply security patches to the underlying operating system of the Managed PostgreSQL Database. Use the `updates` object in this operation to modify the maintenance window for these updates. - If your database cluster is configured with a single node, downtime occurs during maintenance updates. Use the `updates` object to adjust the window to match a time that's the least disruptive to your application and users. Also consider upgrading to a [high availability](https://techdocs.akamai.com/cloud-computing/docs/aiven-database-clusters#high-availability) plan to avoid any maintenance downtime. - Major upgrades are optional until the service reaches end of service, and can be done in place. - You can't update `engine_config` advanced parameter settings for a suspended database. You'll need to [resume](ref:resume-databases-postgre-sql-instance) it first. - A successful request triggers a `database_update` [event](ref:get-events). - **Beta**. You can update an existing PostgreSQL Managed Database to move it to a Virtual Private Cloud (VPC) using the `private_network` object in the request. This support is in beta. Talk to your Akamai account team for more details. > 📘 > > Currently, VPC subnets associated with Managed Database instances don't automatically block outbound connections outside the subnet. To limit network exposure, you should configure Cloud Firewall rules to explicitly deny outbound connections beyond the intended subnet. For more details on configuring rules, see the [Cloud Firewall](https://techdocs.akamai.com/cloud-computing/docs/cloud-firewall) documentation. **Permissions and scopes** To call this operation, you need the following: - **Identity and access permissions**. Your user needs these roles assigned. [Learn more](https://techdocs.akamai.com/cloud-computing/docs/identity-access-cm-available-roles). - Roles: `database_admin` - **OAuth scopes**. Your user needs these scopes assigned. [Learn more](https://techdocs.akamai.com/linode-api/reference/get-started#oauth). - Scopes: `databases:read_write` **CLI** ```shell linode-cli databases postgresql-update 123 \ --label example-db \ --allow_list 203.0.113.1 \ --allow_list 192.0.1.0/24 \ --type g6-standard-1 \ --updates.frequency weekly \ --updates.duration 3 \ --updates.hour_of_day 12 \ --updates.day_of_week 4 \ ``` [Learn more](https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli) - [Patch a PostgreSQL Managed Database](https://techdocs.akamai.com/linode-api/reference/post-databases-postgre-sql-instance-patch.md): Apply security patches and updates to the underlying operating system of the PostgreSQL Managed Database. This function runs during regular maintenance windows, which you can configure with the [Update a managed PostgreSQL database](ref:put-databases-postgre-sql-instance) operation. - The database's status needs to be `active`. - If your database cluster is configured with a single node, downtime occurs during maintenance updates. Consider upgrading to a [high availability](https://techdocs.akamai.com/cloud-computing/docs/aiven-database-clusters#high-availability) plan to avoid any maintenance downtime. - Major upgrades are optional until the service reaches end of service, and can be done in place. - A successful request triggers a `database_upgrade` [event](ref:get-events). **Permissions and scopes** To call this operation, you need the following: - **Identity and access permissions**. Your user needs these roles assigned. [Learn more](https://techdocs.akamai.com/cloud-computing/docs/identity-access-cm-available-roles). - Roles: `database_admin` - **OAuth scopes**. Your user needs these scopes assigned. [Learn more](https://techdocs.akamai.com/linode-api/reference/get-started#oauth). - Scopes: `databases:read_write` **CLI** ```shell linode-cli databases postgresql-patch 123 ``` [Learn more](https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli) - [Suspend a PostgreSQL Managed Database](https://techdocs.akamai.com/linode-api/reference/suspend-databases-postgre-sql-instance.md): Suspend a PostgreSQL Managed Database from your account, releasing idle resources and keeping only necessary data. All service data is lost if there are no backups available. This halts billing for the cluster. - The database's status needs to be `active`. - Akamai deletes suspended clusters after 180 days. - A successful request triggers a `database_suspend` [event](ref:get-events). **Permissions and scopes** To call this operation, you need the following: - **Identity and access permissions**. Your user needs these roles assigned. [Learn more](https://techdocs.akamai.com/cloud-computing/docs/identity-access-cm-available-roles). - Roles: `database_admin` - **OAuth scopes**. Your user needs these scopes assigned. [Learn more](https://techdocs.akamai.com/linode-api/reference/get-started#oauth). - Scopes: `databases:read_write` **CLI** ```shell linode-cli databases postgresql-suspend 123 ``` [Learn more](https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli) - [Resume a PostgreSQL Managed Database](https://techdocs.akamai.com/linode-api/reference/resume-databases-postgre-sql-instance.md): Resume a suspended PostgreSQL Managed Database from your account. This resumes billing for the cluster. - The database's status needs to be `suspended`. - A successful request triggers a `database_resume` [event](ref:get-events). **Permissions and scopes** To call this operation, you need the following: - **Identity and access permissions**. Your user needs these roles assigned. [Learn more](https://techdocs.akamai.com/cloud-computing/docs/identity-access-cm-available-roles). - Roles: `database_admin` - **OAuth scopes**. Your user needs these scopes assigned. [Learn more](https://techdocs.akamai.com/linode-api/reference/get-started#oauth). - Scopes: `databases:read_write` **CLI** ```shell linode-cli databases postgresql-resume 123 ``` [Learn more](https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli) - [Delete a PostgreSQL Managed Database](https://techdocs.akamai.com/linode-api/reference/delete-databases-postgre-sql-instance.md): Deletes a PostgreSQL Managed Database from your account. **Permissions and scopes** To call this operation, you need the following: - **Identity and access permissions**. Your user needs these roles assigned. [Learn more](https://techdocs.akamai.com/cloud-computing/docs/identity-access-cm-available-roles). - Roles: `database_admin` - **OAuth scopes**. Your user needs these scopes assigned. [Learn more](https://techdocs.akamai.com/linode-api/reference/get-started#oauth). - Scopes: `databases:read_write` **CLI** ```shell linode-cli databases postgresql-delete 123 ``` [Learn more](https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli) - [List PostgreSQL Managed Database advanced parameters](https://techdocs.akamai.com/linode-api/reference/get-databases-postgresql-config.md): All advanced parameters you can apply to a PostgreSQL Managed Database, via our partner [Aiven](https://aiven.io/docs/products/postgresql/reference/advanced-params). > 📘 > > Aiven may offer other parameters, but Akamai Managed Databases only supports the ones listed in this operation. **Permissions and scopes** To call this operation, you need the following: - **Identity and access permissions**. Your user needs these roles assigned. [Learn more](https://techdocs.akamai.com/cloud-computing/docs/identity-access-cm-available-roles). - Roles: `database_viewer` - **OAuth scopes**. Your user needs these scopes assigned. [Learn more](https://techdocs.akamai.com/linode-api/reference/get-started#oauth). - Scopes: `databases:read_only` **CLI** ```shell linode-cli databases postgres-config ``` [Learn more](https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli) - [Get a PostgreSQL Managed Database SSL certificate](https://techdocs.akamai.com/linode-api/reference/get-databases-postgresql-instance-ssl.md): Display the SSL CA certificate for an accessible PostgreSQL Managed Database. The database's status needs to be `active`. **Permissions and scopes** To call this operation, you need the following: - **Identity and access permissions**. Your user needs these roles assigned. [Learn more](https://techdocs.akamai.com/cloud-computing/docs/identity-access-cm-available-roles). - Roles: `database_viewer` - **OAuth scopes**. Your user needs these scopes assigned. [Learn more](https://techdocs.akamai.com/linode-api/reference/get-started#oauth). - Scopes: `databases:read_only` **CLI** ```shell linode-cli databases postgresql-ssl-cert 123 ``` [Learn more](https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli) - [Get PostgreSQL Managed Database credentials](https://techdocs.akamai.com/linode-api/reference/get-databases-postgre-sql-instance-credentials.md): Display the root username and password for an accessible PostgreSQL Managed Database. The database's status needs to be `active`. **Permissions and scopes** To call this operation, you need the following: - **Identity and access permissions**. Your user needs these roles assigned. [Learn more](https://techdocs.akamai.com/cloud-computing/docs/identity-access-cm-available-roles). - Roles: `database_viewer` - **OAuth scopes**. Your user needs these scopes assigned. [Learn more](https://techdocs.akamai.com/linode-api/reference/get-started#oauth). - Scopes: `databases:read_only` **CLI** ```shell linode-cli databases postgresql-creds-view 123 ``` [Learn more](https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli) - [Reset PostgreSQL Managed Database credentials](https://techdocs.akamai.com/linode-api/reference/post-databases-postgre-sql-instance-credentials-reset.md): Reset the root password for a PostgreSQL Managed Database. A new root password is randomly generated and accessible with the [Get PostgreSQL Managed Database credentials](ref:get-databases-postgre-sql-instance-credentials) operation. - The database's status needs to be `active`. - It may take several seconds for credentials to reset. **Permissions and scopes** To call this operation, you need the following: - **Identity and access permissions**. Your user needs these roles assigned. [Learn more](https://techdocs.akamai.com/cloud-computing/docs/identity-access-cm-available-roles). - Roles: `database_admin` - **OAuth scopes**. Your user needs these scopes assigned. [Learn more](https://techdocs.akamai.com/linode-api/reference/get-started#oauth). - Scopes: `databases:read_write` **CLI** ```shell linode-cli databases postgresql-creds-reset 123 ``` [Learn more](https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli) - [Create a PostgreSQL connection pool](https://techdocs.akamai.com/linode-api/reference/post-databases-postgre-sql-conn-pools.md): Configure PGBouncer connection pool settings, using our partner [Aiven's specification](https://aiven.io/docs/products/postgresql/reference/advanced-params#pgbouncer). You can only create a connection pool on an active cluster in an existing PostgreSQL Managed Database. Run the [List PostgreSQL Managed Databases](ref:get-databases-postgre-sql-instances) operation, locate the desired database, and verify its `status` is `active`. Then store both its `id`, as your `postgresqlInstanceId`, and its `label`. **Permissions and scopes** To call this operation, you need the following: - **Identity and access permissions**. Your user needs these roles assigned. [Learn more](https://techdocs.akamai.com/cloud-computing/docs/identity-access-cm-available-roles). - Roles: `database_admin` - **OAuth scopes**. Your user needs these scopes assigned. [Learn more](https://techdocs.akamai.com/linode-api/reference/get-started#oauth). - Scopes: `databases:read_write` **CLI** ```shell linode-cli databases postgresql-conn-pool-create \ --database PostgreSQL-DB-video-streaming-data --mode session --label Connection-Pool-01 \ --size 10 \ --username john-doe ``` [Learn more](https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli) - [List PostgreSQL connection pools](https://techdocs.akamai.com/linode-api/reference/get-databases-postgre-sql-conn-pools.md): View all of the PGBouncer connection pools for a specific PostgreSQL Managed Database. PGBouncer is an advanced configuration setting you can assign to your database, through our partner [Aiven](https://aiven.io/docs/products/postgresql/reference/advanced-params#pgbouncer). **Permissions and scopes** To call this operation, you need the following: - **Identity and access permissions**. Your user needs these roles assigned. [Learn more](https://techdocs.akamai.com/cloud-computing/docs/identity-access-cm-available-roles). - Roles: `database_viewer` - **OAuth scopes**. Your user needs these scopes assigned. [Learn more](https://techdocs.akamai.com/linode-api/reference/get-started#oauth). - Scopes: `databases:read_write` **CLI** ```shell linode-cli databases postgresql-conn-pool-list ``` [Learn more](https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli) - [Get a PostgreSQL connection pool](https://techdocs.akamai.com/linode-api/reference/get-databases-postgre-sql-conn-pool.md): Returns a specific connection pool for a PostgreSQL Managed Database. **Permissions and scopes** To call this operation, you need the following: - **Identity and access permissions**. Your user needs these roles assigned. [Learn more](https://techdocs.akamai.com/cloud-computing/docs/identity-access-cm-available-roles). - Roles: `database_viewer` - **OAuth scopes**. Your user needs these scopes assigned. [Learn more](https://techdocs.akamai.com/linode-api/reference/get-started#oauth). - Scopes: `databases:read_only` **CLI** ```shell linode-cli postgresql-conn-pool-view 890 ``` [Learn more](https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli) - [Update a PostgreSQL connection pool](https://techdocs.akamai.com/linode-api/reference/put-databases-postgre-sql-conn-pool.md): Update PGBouncer connection pool settings for a PostgreSQL Managed Database, using our partner [Aiven's specification](https://aiven.io/docs/products/postgresql/reference/advanced-params#pgbouncer). > 🚧 > > This operation can cause sudden closure of an in-use connection pool. **Permissions and scopes** To call this operation, you need the following: - **Identity and access permissions**. Your user needs these roles assigned. [Learn more](https://techdocs.akamai.com/cloud-computing/docs/identity-access-cm-available-roles). - Roles: `database_admin` - **OAuth scopes**. Your user needs these scopes assigned. [Learn more](https://techdocs.akamai.com/linode-api/reference/get-started#oauth). - Scopes: `databases:read_write` **CLI** ```shell linode-cli databases postgresql-conn-pool-update 123 \ --database PostgreSQL-DB-video-streaming-data-legacy --mode session --label Connection-Pool-01 \ --size 10 \ --username john-doe ``` [Learn more](https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli) - [Delete a PostgreSQL connection pool](https://techdocs.akamai.com/linode-api/reference/delete-databases-postgre-sql-conn-pool.md): Delete a specific connection pool from a PostgreSQL Managed Database. **Permissions and scopes** To call this operation, you need the following: - **Identity and access permissions**. Your user needs these roles assigned. [Learn more](https://techdocs.akamai.com/cloud-computing/docs/identity-access-cm-available-roles). - Roles: `database_admin` - **OAuth scopes**. Your user needs these scopes assigned. [Learn more](https://techdocs.akamai.com/linode-api/reference/get-started#oauth). - Scopes: `databases:read_write` **CLI** ```shell linode-cli postgresql-conn-pool-delete 890 ``` [Learn more](https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli) - [Create a domain](https://techdocs.akamai.com/linode-api/reference/post-domain.md): Adds a new Domain to Linode's DNS Manager. Linode is not a registrar, and you must own the domain before adding it here. Be sure to point your registrar to Linode's nameservers so that the records hosted here are used. **Permissions and scopes** To call this operation, you need permissions, based on the model you're using: - **Identity and access permissions**. Your user needs a role with these permissions. [Learn more](https://techdocs.akamai.com/cloud-computing/docs/identity-access-cm-available-roles). - Roles: `account_domain_creator` - **OAuth scopes**. Your user needs these scopes assigned. [Learn more](https://techdocs.akamai.com/linode-api/reference/get-started#oauth). - Scopes: `domains:read_write` **CLI** ```shell linode-cli domains create \ --type master \ --domain example.org \ --soa_email admin@example.org ``` [Learn more](https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli) - [List domains](https://techdocs.akamai.com/linode-api/reference/get-domains.md): This is a collection of Domains that you have registered in Linode's DNS Manager. Linode is not a registrar, and in order for these to work you must own the domains and point your registrar at Linode's nameservers. **Permissions and scopes** To call this operation, you need permissions, based on the model you're using: - **Identity and access permissions**. Your user needs a role with these permissions. [Learn more](https://techdocs.akamai.com/cloud-computing/docs/identity-access-cm-available-roles). - Roles: `domain_viewer` - **OAuth scopes**. Your user needs these scopes assigned. [Learn more](https://techdocs.akamai.com/linode-api/reference/get-started#oauth). - Scopes: `domains:read_only` **CLI** ```shell linode-cli domains list ``` [Learn more](https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli) - [Import a domain](https://techdocs.akamai.com/linode-api/reference/post-import-domain.md): Imports a domain zone from a remote nameserver. Your nameserver must allow zone transfers (AXFR) from the following IPs: - 96.126.114.97 - 96.126.114.98 - 2600:3c00::5e - 2600:3c00::5f **Permissions and scopes** To call this operation, you need permissions, based on the model you're using: - **Identity and access permissions**. Your user needs a role with these permissions. [Learn more](https://techdocs.akamai.com/cloud-computing/docs/identity-access-cm-available-roles). - Roles: `domain_admin` - **OAuth scopes**. Your user needs these scopes assigned. [Learn more](https://techdocs.akamai.com/linode-api/reference/get-started#oauth). - Scopes: `domains:read_write` **CLI** ```shell linode-cli domains import --domain example.com --remote_nameserver examplenameserver.com ``` [Learn more](https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli) - [Get a domain](https://techdocs.akamai.com/linode-api/reference/get-domain.md): This is a single Domain that you have registered in Linode's DNS Manager. Linode is not a registrar, and in order for this Domain record to work you must own the domain and point your registrar at Linode's nameservers. **Permissions and scopes** To call this operation, you need permissions, based on the model you're using: - **Identity and access permissions**. Your user needs a role with these permissions. [Learn more](https://techdocs.akamai.com/cloud-computing/docs/identity-access-cm-available-roles). - Roles: `domain_viewer` - **OAuth scopes**. Your user needs these scopes assigned. [Learn more](https://techdocs.akamai.com/linode-api/reference/get-started#oauth). - Scopes: `domains:read_only` **CLI** ```shell linode-cli domains view 123 ``` [Learn more](https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli) - [Update a domain](https://techdocs.akamai.com/linode-api/reference/put-domain.md): Update information about a Domain in Linode's DNS Manager. **Permissions and scopes** To call this operation, you need permissions, based on the model you're using: - **Identity and access permissions**. Your user needs a role with these permissions. [Learn more](https://techdocs.akamai.com/cloud-computing/docs/identity-access-cm-available-roles). - Roles: `domain_admin` - **OAuth scopes**. Your user needs these scopes assigned. [Learn more](https://techdocs.akamai.com/linode-api/reference/get-started#oauth). - Scopes: `domains:read_write` **CLI** ```shell linode-cli domains update 1234 \ --retry_sec 7200 \ --ttl_sec 300 ``` [Learn more](https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli) - [Delete a domain](https://techdocs.akamai.com/linode-api/reference/delete-domain.md): Deletes a Domain from Linode's DNS Manager. The Domain will be removed from Linode's nameservers shortly after this operation completes. This also deletes all associated Domain Records. **Permissions and scopes** To call this operation, you need permissions, based on the model you're using: - **Identity and access permissions**. Your user needs a role with these permissions. [Learn more](https://techdocs.akamai.com/cloud-computing/docs/identity-access-cm-available-roles). - Roles: `domain_admin` - **OAuth scopes**. Your user needs these scopes assigned. [Learn more](https://techdocs.akamai.com/linode-api/reference/get-started#oauth). - Scopes: `domains:read_write` **CLI** ```shell linode-cli domains delete 1234 ``` [Learn more](https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli) - [Clone a domain](https://techdocs.akamai.com/linode-api/reference/post-clone-domain.md): Clones a Domain and all associated DNS records from a Domain that is registered in Linode's DNS manager. **Permissions and scopes** To call this operation, you need permissions, based on the model you're using: - **Identity and access permissions**. Your user needs a role with these permissions. [Learn more](https://techdocs.akamai.com/cloud-computing/docs/identity-access-cm-available-roles). - Roles: `domain_admin` - **OAuth scopes**. Your user needs these scopes assigned. [Learn more](https://techdocs.akamai.com/linode-api/reference/get-started#oauth). - Scopes: `domains:read_write` **CLI** ```shell linode-cli domains clone 123 --domain example.com ``` [Learn more](https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli) - [Create a domain record](https://techdocs.akamai.com/linode-api/reference/post-domain-record.md): Adds a new Domain Record to the zonefile this Domain represents. Each domain can have up to 12,000 active records. **Permissions and scopes** To call this operation, you need permissions, based on the model you're using: - **Identity and access permissions**. Your user needs a role with these permissions. [Learn more](https://techdocs.akamai.com/cloud-computing/docs/identity-access-cm-available-roles). - Roles: `account_domain_creator` - **OAuth scopes**. Your user needs these scopes assigned. [Learn more](https://techdocs.akamai.com/linode-api/reference/get-started#oauth). - Scopes: `domains:read_write` **CLI** ```shell linode-cli domains records-create 123 \ --type A \ --name test \ --target 203.0.113.1 \ --priority 50 \ --weight 50 \ --port 80 \ --ttl_sec 604800 ``` [Learn more](https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli) - [List domain records](https://techdocs.akamai.com/linode-api/reference/get-domain-records.md): Returns a paginated list of Records configured on a Domain in Linode's DNS Manager. **Permissions and scopes** To call this operation, you need permissions, based on the model you're using: - **Identity and access permissions**. Your user needs a role with these permissions. [Learn more](https://techdocs.akamai.com/cloud-computing/docs/identity-access-cm-available-roles). - Roles: `domain_viewer` - **OAuth scopes**. Your user needs these scopes assigned. [Learn more](https://techdocs.akamai.com/linode-api/reference/get-started#oauth). - Scopes: `domains:read_only` **CLI** ```shell linode-cli domains records-list 1234 ``` [Learn more](https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli) - [Get a domain record](https://techdocs.akamai.com/linode-api/reference/get-domain-record.md): View a single Record on this Domain. **Permissions and scopes** To call this operation, you need permissions, based on the model you're using: - **Identity and access permissions**. Your user needs a role with these permissions. [Learn more](https://techdocs.akamai.com/cloud-computing/docs/identity-access-cm-available-roles). - Roles: `domain_viewer` - **OAuth scopes**. Your user needs these scopes assigned. [Learn more](https://techdocs.akamai.com/linode-api/reference/get-started#oauth). - Scopes: `domains:read_only` **CLI** ```shell linode-cli domains records-view 123 234 ``` [Learn more](https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli) - [Update a domain record](https://techdocs.akamai.com/linode-api/reference/put-domain-record.md): Updates a single Record on this Domain. **Permissions and scopes** To call this operation, you need permissions, based on the model you're using: - **Identity and access permissions**. Your user needs a role with these permissions. [Learn more](https://techdocs.akamai.com/cloud-computing/docs/identity-access-cm-available-roles). - Roles: `domain_admin` - **OAuth scopes**. Your user needs these scopes assigned. [Learn more](https://techdocs.akamai.com/linode-api/reference/get-started#oauth). - Scopes: `domains:read_write` **CLI** ```shell linode-cli domains records-update 123 234 \ --name test \ --target 203.0.113.1 \ --priority 50 \ --weight 50 \ --port 80 \ --ttl_sec 604800 ``` [Learn more](https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli) - [Delete a domain record](https://techdocs.akamai.com/linode-api/reference/delete-domain-record.md): Deletes a Record on this Domain. **Permissions and scopes** To call this operation, you need permissions, based on the model you're using: - **Identity and access permissions**. Your user needs a role with these permissions. [Learn more](https://techdocs.akamai.com/cloud-computing/docs/identity-access-cm-available-roles). - Roles: `domain_admin` - **OAuth scopes**. Your user needs these scopes assigned. [Learn more](https://techdocs.akamai.com/linode-api/reference/get-started#oauth). - Scopes: `domains:read_write` **CLI** ```shell linode-cli domains records-delete 123 234 ``` [Learn more](https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli) - [Get a domain zone file](https://techdocs.akamai.com/linode-api/reference/get-domain-zone.md): Returns the zone file for the last rendered zone for the specified domain. **Permissions and scopes** To call this operation, you need permissions, based on the model you're using: - **Identity and access permissions**. Your user needs a role with these permissions. [Learn more](https://techdocs.akamai.com/cloud-computing/docs/identity-access-cm-available-roles). - Roles: `domain_viewer` - **OAuth scopes**. Your user needs these scopes assigned. [Learn more](https://techdocs.akamai.com/linode-api/reference/get-started#oauth). - Scopes: `domains:read_only` **CLI** ```shell linode-cli domains zone-file 123 ``` [Learn more](https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli) - [List entities](https://techdocs.akamai.com/linode-api/reference/get-entities.md): Lists entities created on the account. An *entity* is an object that has a life-cycle and can be managed by an authorized user within an account, for example: a specific virtual machine or firewall. You can manage an entity over time by performing operations on it, based on your access level. > 📘 Before you begin > > Before you run this operation, read [Comparison of Linode API for grants and Identity and Access](https://techdocs.akamai.com/cloud-computing/docs/migration-grants-identity-and-access#comparison-of-linode-api-for-grants-and-identity-and-access) to learn about the new experience and recommended use of the Identity and Access endpoints. **Permissions and scopes** To call this operation, you need the following: - **Identity and access permissions**. Your user needs a role with these permissions assigned. [Learn more](https://techdocs.akamai.com/cloud-computing/docs/identity-access-cm-available-roles). - Permissions: `list_entities` - [List available roles](https://techdocs.akamai.com/linode-api/reference/get-role-permissions.md): Lists available account access and entity access roles, their descriptions, and included permissions. Use these roles to manage users' access level to specific services and entities. - **Account access roles**. These roles give access to account level operations, entities in the account both existing and to be created in the future, and creation of new entities. - **Entity access roles**. These roles provide access to specific entities that are already available on the account. To learn more, see the [Identity and Access in Cloud Manager terminology](https://techdocs.akamai.com/cloud-computing/docs/identity-and-access-cm#terminology). > 📘 Before you begin > > Before you run this operation, read [Comparison of Linode API for grants and Identity and Access](https://techdocs.akamai.com/cloud-computing/docs/migration-grants-identity-and-access#comparison-of-linode-api-for-grants-and-identity-and-access) to learn about the new experience and recommended use of the Identity and Access endpoints. **Permissions and scopes** To call this operation, you need the following: - **Identity and access permissions**. Your user needs a role with these permissions assigned. [Learn more](https://techdocs.akamai.com/cloud-computing/docs/identity-access-cm-available-roles). - Permissions: `list_role_permissions` - [Get a user's access level](https://techdocs.akamai.com/linode-api/reference/get-iam-users-role-permissions.md): Returns a user's access level on the account. The response includes account access and entity access roles. - **Account access roles**. These roles give access to account level operations, entities in the account both existing and to be created in the future, and creation of new entities. - **Entity access roles**. These roles provide access to specific entities that are already available on the account. To learn more, see the [Identity and Access in Cloud Manager terminology](https://techdocs.akamai.com/cloud-computing/docs/identity-and-access-cm#terminology). > 📘 Before you begin > > Before you run this operation, read [Comparison of Linode API for grants and Identity and Access](https://techdocs.akamai.com/cloud-computing/docs/migration-grants-identity-and-access#comparison-of-linode-api-for-grants-and-identity-and-access) to learn about the new experience and recommended use of the new Identity and Access endpoints. **Permissions and scopes** To call this operation, you need the following: - **Identity and access permissions**. Your user needs a role with these permissions assigned. [Learn more](https://techdocs.akamai.com/cloud-computing/docs/identity-access-cm-available-roles). - Permissions: `list_user_permissions` - [Update a user's access level](https://techdocs.akamai.com/linode-api/reference/put-iam-users-role-permissions.md): Updates a user's access level on the account. The request includes account access and entity access roles. - **Account access roles**. These roles give access to account level operations, entities in the account both existing and to be created in the future, and creation of new entities. - **Entity access roles**. These roles provide access to specific entities that are already available on the account. To learn more, see the [Identity and Access in Cloud Manager terminology](https://techdocs.akamai.com/cloud-computing/docs/identity-and-access-cm#terminology). This operation replaces any existing role assignment. To completely block user's access to the account, pass an empty list, `[]`. To get the list of available roles, run the [List available roles](ref:get-role-permissions) operation. > 📘 Before you begin > > Before you run this operation, read [Comparison of Linode API for grants and Identity and Access](https://techdocs.akamai.com/cloud-computing/docs/migration-grants-identity-and-access#comparison-of-linode-api-for-grants-and-identity-and-access) to learn about the new experience and recommended use of the new Identity and Access endpoints. **Permissions and scopes** To call this operation, you need the following: - **Identity and access permissions**. Your user needs a role with these permissions assigned. [Learn more](https://techdocs.akamai.com/cloud-computing/docs/identity-access-cm-available-roles). - Permissions: `update_user_permissions` - [List child accounts](https://techdocs.akamai.com/linode-api/reference/get-iam-delegation-all-child-accounts.md): Returns the list of available child accounts under your parent account. With the `users` query parameter set to `true`, it also returns the account delegation for each child account. An *account delegation* is a group of parent account users, either admin or non-admin, delegated to manage a specific child account. The child account's admins manage the role assignment of delegate users on the child account. To learn more about the parent and child accounts feature and account delegations, see [Parent and child accounts](https://techdocs.akamai.com/cloud-computing/docs/parent-and-child-accounts-for-akamai-partners). > 📘 Parent and child accounts feature > > This operation is available only within the context of the parent and child accounts feature and can be run only on a parent account. **Permissions and scopes** To call this operation, you need the following: - **Identity and access permissions**. Your user needs a role with these permissions assigned. [Learn more](https://techdocs.akamai.com/cloud-computing/docs/identity-access-cm-available-roles). - Permissions: `list_all_child_accounts` - [Get the account delegation for a child account](https://techdocs.akamai.com/linode-api/reference/get-iam-delegation-child-account-users.md): Returns the list of users added to the account delegation for a specific child account. An *account delegation* is a group of parent account users, either admin or non-admin, delegated to manage a specific child account. The child account's admins manage the role assignment of delegate users on the child account. To learn more about the parent and child accounts feature and account delegations, see [Parent and child accounts](https://techdocs.akamai.com/cloud-computing/docs/parent-and-child-accounts-for-akamai-partners). > 📘 Parent and child accounts feature > > This operation is available only within the context of the parent and child accounts feature and can be run only on a parent account. **Permissions and scopes** To call this operation, you need the following: - **Identity and access permissions**. Your user needs a role with these permissions assigned. [Learn more](https://techdocs.akamai.com/cloud-computing/docs/identity-access-cm-available-roles). - Permissions: `list_delegate_users` - [Update the account delegation for a child account](https://techdocs.akamai.com/linode-api/reference/put-iam-delegation-child-account-users.md): Updates the list of users added to the account delegation for a specific child account. An *account delegation* is a group of parent account users, either admin or non-admin, delegated to manage a specific child account. The child account's admins manage the role assignment of delegate users on the child account. To learn more about the parent and child accounts feature and account delegations, see [Parent and child accounts](https://techdocs.akamai.com/cloud-computing/docs/parent-and-child-accounts-for-akamai-partners). > 📘 Parent and child accounts feature > > This operation is available only within the context of the parent and child accounts feature and can be run only on a parent account. **Permissions and scopes** To call this operation, you need the following: - **Identity and access permissions**. Your user needs a role with these permissions assigned. [Learn more](https://techdocs.akamai.com/cloud-computing/docs/identity-access-cm-available-roles). - Permissions: `update_delegate_users` - [Get the default role assignment for delegate users](https://techdocs.akamai.com/linode-api/reference/get-iam-delegation-default-role-permissions.md): Returns roles assigned to new delegate users by default. A *delegate user* is a user from the parent account delegated by a parent account's admin on the parent account to have access to your, child, account. Note that the delegate users' access can be modified just as a regular child account user, so the returned list doesn't provide the role assignment of all delegate users. To get the detailed role assignment of a delegate user, run the [Get a user's access level](ref:get-iam-users-role-permissions) operation. To learn more about the parent and child accounts feature and account delegations, see [Parent and child accounts](https://techdocs.akamai.com/cloud-computing/docs/parent-and-child-accounts-for-akamai-partners). > 📘 Parent and child accounts feature > > This operation is available only within the context of the parent and child accounts feature and can be run only on a child account. **Permissions and scopes** To call this operation, you need the following: - **Identity and access permissions**. Your user needs a role with these permissions assigned. [Learn more](https://techdocs.akamai.com/cloud-computing/docs/identity-access-cm-available-roles). - Permissions: `view_default_delegate_access` - [Update the default role assignment for delegate users](https://techdocs.akamai.com/linode-api/reference/put-iam-delegation-default-role-permissions.md): Updates the default role assignment for new delegate users on your child account. A *delegate user* is a user from the parent account delegated by a parent account's admin on the parent account to have access to your, child, account. Note that the change applies only to new delegate users coming to your account. To edit current delegate users' access, you need to run the [Update a user's access level](ref:put-iam-users-role-permissions) operation. To learn more about the parent and child accounts feature and account delegations, see [Parent and child accounts](https://techdocs.akamai.com/cloud-computing/docs/parent-and-child-accounts-for-akamai-partners). > 📘 Parent and child accounts feature > > This operation is available only within the context of the parent and child accounts feature and can be run only on a child account by its admin. **Permissions and scopes** To call this operation, you need the following: - **Identity and access permissions**. Your user needs a role with these permissions assigned. [Learn more](https://techdocs.akamai.com/cloud-computing/docs/identity-access-cm-available-roles). - Permissions: `update_default_delegate_access` - [Get your account delegations](https://techdocs.akamai.com/linode-api/reference/get-iam-delegation-profile-child-account.md): Returns the list of child accounts you are part of the account delegation for. An *account delegation* is a group of parent account users, either admin or non-admin, delegated to manage a specific child account. The child account's admins manage the role assignment of delegate users on the child account. To learn more about the parent and child accounts feature and account delegations, see [Parent and child accounts](https://techdocs.akamai.com/cloud-computing/docs/parent-and-child-accounts-for-akamai-partners). > 📘 Parent and child accounts feature > > This operation is available only within the context of the parent and child accounts feature and can be run only on a parent account. **Permissions and scopes** To call this operation, you need the following: - **Identity and access permissions**. Your user needs a role with these permissions assigned. [Learn more](https://techdocs.akamai.com/cloud-computing/docs/identity-access-cm-available-roles). - Permissions: `list_user_delegate_accounts` - [Get a child account](https://techdocs.akamai.com/linode-api/reference/get-delegation-profile-child-account.md): Returns details on a specific child account you are part of the account delegation team for. To learn more about the parent and child accounts feature and account delegations, see [Parent and child accounts](https://techdocs.akamai.com/cloud-computing/docs/parent-and-child-accounts-for-akamai-partners). > 📘 Parent and child accounts feature > > This operation is available only within the context of the parent and child accounts feature and can be run only on a parent account. **Permissions and scopes** To call this operation, you need the following: - **Identity and access permissions**. Your user needs a role with these permissions assigned. [Learn more](https://techdocs.akamai.com/cloud-computing/docs/identity-access-cm-available-roles). - Permissions: `list_all_child_accounts` - [Create a delegate user token](https://techdocs.akamai.com/linode-api/reference/post-iam-delegation-profile-child-account-token.md): Creates a short-lived bearer token for you as a delegate user to run API operations on a specific child account. The token inherits the permissions set by a child account admin for your delegate user. Your username as the delegate user follows the specific naming convention: - These variables only use the first 15 and 16 characters of these values, respectively. > 📘 > > The API returns the raw token in the response. You can't get it again, so be sure to store it. Example workflow: 1. [List child accounts](ref:get-iam-delegation-all-child-accounts) and store the `euuid` for the applicable one. 2. Run this operation and store the `token` that's created for the delegate user. 3. Run operations on the child account using the stored `token` to authenticate API operations. **Prerequisite**: To manage a child account, you need to be added by a parent account admin to the *account delegation* for the specific child account. An *account delegation* is a group of parent account users, either admin or non-admin, delegated to manage a specific child account. To learn more about the parent and child accounts feature and account delegations, see [Parent and child accounts](https://techdocs.akamai.com/cloud-computing/docs/parent-and-child-accounts-for-akamai-partners). > 📘 Parent and child accounts feature > > This operation is available only within the context of the parent and child accounts feature and can be run only on a parent account. **Permissions and scopes** To call this operation, you need the following: - **Identity and access permissions**. Your user needs a role with these permissions assigned. [Learn more](https://techdocs.akamai.com/cloud-computing/docs/identity-access-cm-available-roles). - Permissions: `No permission, the access is provided by adding a user to an account delegation` - [Get user's account delegations](https://techdocs.akamai.com/linode-api/reference/get-iam-delegation-user-child-accounts.md): Returns the list of child accounts a specific user is part of the account delegation for. An *account delegation* is a group of parent account users, either admin or non-admin, delegated to manage a specific child account. The child account's admins manage the role assignment of delegate users on the child account. To learn more about the parent and child accounts feature and account delegations, see [Parent and child accounts](https://techdocs.akamai.com/cloud-computing/docs/parent-and-child-accounts-for-akamai-partners). > 📘 Parent and child accounts feature > > This operation is available only within the context of the parent and child accounts feature and can be run only on a parent account. **Permissions and scopes** To call this operation, you need the following: - **Identity and access permissions**. Your user needs a role with these permissions assigned. [Learn more](https://techdocs.akamai.com/cloud-computing/docs/identity-access-cm-available-roles). - Permissions: `list_user_delegate_accounts` - [Create an IDP configuration](https://techdocs.akamai.com/linode-api/reference/post-idp-config.md): __Beta__ Creates an external identity provider (IDP) configuration for the account. You can have only one configuration per account. To learn more about the single sign-on for Akamai Cloud, including emergency access accounts setup, see [Single Sign-On](https://techdocs.akamai.com/cloud-computing/docs/single-sign-on-cm). **Prerequisite** You need to have IDP metadata from your identity provider. To create the IDP configuration: 1. Provide a unique label for the configuration. 1. To activate the SSO, set `enabled` to `true`. 1. Enforce SSO for all users of your account with `enforce` set to `true`. The enforcement doesn't apply to [excluded users](ref:get-idp-config-users-excluded). > 📘 > > Set the enforcement to `false`, if you want to test SSO on a small subset of users. After you create this configuration, [add the included users](ref:put-idp-config-users-included) and test the login flow. If the test is successful, enforce the SSO login for all users with the [Update an IDP configuration](ref:put-idp-config) operation. 1. Specify the SAML configuration settings with details from the IDP metadata you got from the identity provider. > 👍 There's a tutorial > > We offer an example API [workflow](ref:configure-sso-login) you can follow to create an IDP configuration, test it, and configure an account with emergency access. > 📘 > > This operation is in Beta and available from the `v4beta` URL. **Permissions and scopes** To call this operation, you need the following: - **Identity and access permissions**. Your user needs a role with these permissions assigned. [Learn more](https://techdocs.akamai.com/cloud-computing/docs/identity-access-cm-available-roles). - Permissions: `create_idp_config` - [List IDP configurations](https://techdocs.akamai.com/linode-api/reference/get-idp-configs.md): __Beta__ Returns a list of all external identity provider (IDP) configurations for the account. For the initial release, the list contains only a single item. > 📘 > > This operation is in Beta and available from the `v4beta` URL. **Permissions and scopes** To call this operation, you need the following: - **Identity and access permissions**. Your user needs a role with these permissions assigned. [Learn more](https://techdocs.akamai.com/cloud-computing/docs/identity-access-cm-available-roles). - Permissions: `view_idp_config` - [Get an IDP configuration](https://techdocs.akamai.com/linode-api/reference/get-idp-config.md): __Beta__ Returns the external identity provider (IDP) configuration for the account. > 📘 > > This operation is in Beta and available from the `v4beta` URL. **Permissions and scopes** To call this operation, you need the following: - **Identity and access permissions**. Your user needs a role with these permissions assigned. [Learn more](https://techdocs.akamai.com/cloud-computing/docs/identity-access-cm-available-roles). - Permissions: `view_idp_config` - [Update an IDP configuration](https://techdocs.akamai.com/linode-api/reference/put-idp-config.md): __Beta__ Updates the external identity provider (IDP) configuration for the account. Top-level properties can be passed individually or together. When included, you need to provide the entire IDP config object and it will overwrite existing values. This operation triggers an `update_idp_config` event. > 📘 > > This operation is in Beta and available from the `v4beta` URL. **Permissions and scopes** To call this operation, you need the following: - **Identity and access permissions**. Your user needs a role with these permissions assigned. [Learn more](https://techdocs.akamai.com/cloud-computing/docs/identity-access-cm-available-roles). - Permissions: `update_idp_config` - [Delete an IDP configuration](https://techdocs.akamai.com/linode-api/reference/delete-idp-config.md): __Beta__ Deletes the external identity provider (IDP) configuration for the account. The configuration object is soft-deleted, while certificates and excluded and included user lists are permanently deleted. > 📘 > > This operation is in Beta and available from the `v4beta` URL. **Permissions and scopes** To call this operation, you need the following: - **Identity and access permissions**. Your user needs a role with these permissions assigned. [Learn more](https://techdocs.akamai.com/cloud-computing/docs/identity-access-cm-available-roles). - Permissions: `delete_idp_config` - [Add an IDP certificate](https://techdocs.akamai.com/linode-api/reference/post-idp-config-certificate.md): __Beta__ Adds a new public certificate to the external identity provider (IDP) configuration. One configuration can have several certificates to support a certificate rotation. > 📘 > > This operation is in Beta and available from the `v4beta` URL. **Permissions and scopes** To call this operation, you need the following: - **Identity and access permissions**. Your user needs a role with these permissions assigned. [Learn more](https://techdocs.akamai.com/cloud-computing/docs/identity-access-cm-available-roles). - Permissions: `create_idp_config_cert` - [List IDP certificates](https://techdocs.akamai.com/linode-api/reference/get-idp-config-certificates.md): __Beta__ Returns the list of public certificates for the external identity provider (IDP) configuration. The IDP configuration needs to have at least one valid certificate at all times. You can [add several certificates](ref:post-idp-config-certificate) or [remove the expired ones](ref:delete-idp-config-certificate). > 📘 > > This operation is in Beta and available from the `v4beta` URL. **Permissions and scopes** To call this operation, you need the following: - **Identity and access permissions**. Your user needs a role with these permissions assigned. [Learn more](https://techdocs.akamai.com/cloud-computing/docs/identity-access-cm-available-roles). - Permissions: `view_idp_config_certs` - [Delete an IDP certificate](https://techdocs.akamai.com/linode-api/reference/delete-idp-config-certificate.md): __Beta__ Deletes a specific certificate from the external identity provider (IDP) configuration. The IDP configuration needs to have at least one valid certificate at all times. If all existing certificates are expired, [add a new valid one](ref:post-idp-config-certificate) before removing the expired ones. > 📘 > > This operation is in Beta and available from the `v4beta` URL. **Permissions and scopes** To call this operation, you need the following: - **Identity and access permissions**. Your user needs a role with these permissions assigned. [Learn more](https://techdocs.akamai.com/cloud-computing/docs/identity-access-cm-available-roles). - Permissions: `delete_idp_config_cert` - [List excluded users](https://techdocs.akamai.com/linode-api/reference/get-idp-config-users-excluded.md): __Beta__ Returns the list of users excluded from the IDP configuration. Excluded users are part of the emergency account access (*break-glass user*) setup. They bypass the SSO enforcement and continue to log in with a password. To learn more, see [Emergency access accounts](https://techdocs.akamai.com/cloud-computing/docs/single-sign-on-cm#emergency-access-accounts). > 📘 > > This operation is in Beta and available from the `v4beta` URL. **Permissions and scopes** To call this operation, you need the following: - **Identity and access permissions**. Your user needs a role with these permissions assigned. [Learn more](https://techdocs.akamai.com/cloud-computing/docs/identity-access-cm-available-roles). - Permissions: `view_idp_config_user_excludes` - [Update excluded users](https://techdocs.akamai.com/linode-api/reference/put-idp-config-users-excluded.md): __Beta__ Replaces the list of users excluded from the IDP configuration. Excluded users are part of the emergency account access (*break-glass user*) setup. They bypass the SSO enforcement and continue to log in with a password. Pass an empty `usernames` array to clear the list. To learn more about emergency access accounts and their recommended setup, see [Emergency access accounts](https://techdocs.akamai.com/cloud-computing/docs/single-sign-on-cm#emergency-access-accounts). > 📘 > > This operation is in Beta and available from the `v4beta` URL. **Permissions and scopes** To call this operation, you need the following: - **Identity and access permissions**. Your user needs a role with these permissions assigned. [Learn more](https://techdocs.akamai.com/cloud-computing/docs/identity-access-cm-available-roles). - Permissions: `update_idp_config_user_excludes` - [List included users](https://techdocs.akamai.com/linode-api/reference/get-idp-config-users-included.md): __Beta__ Returns the list of users that are required to authenticate with SSO when the SSO enforcement is disabled. Use the included users to test the IDP configuration before enforcing it for all users. > 📘 > > This operation is in Beta and available from the `v4beta` URL. **Permissions and scopes** To call this operation, you need the following: - **Identity and access permissions**. Your user needs a role with these permissions assigned. [Learn more](https://techdocs.akamai.com/cloud-computing/docs/identity-access-cm-available-roles). - Permissions: `view_idp_config_user_includes` - [Update included users](https://techdocs.akamai.com/linode-api/reference/put-idp-config-users-included.md): __Beta__ Replaces the list of users that are required to authenticate with SSO when the SSO enforcement is disabled. Use the included users to test the IDP configuration before enforcing it for all users. Pass an empty `usernames` array to clear the list. > 📘 > > This operation is in Beta and available from the `v4beta` URL. **Permissions and scopes** To call this operation, you need the following: - **Identity and access permissions**. Your user needs a role with these permissions assigned. [Learn more](https://techdocs.akamai.com/cloud-computing/docs/identity-access-cm-available-roles). - Permissions: `update_idp_config_user_includes` - [Create an image](https://techdocs.akamai.com/linode-api/reference/post-image.md): Captures a private, gold image from a Linode disk and stores it for later use. > 👍 There's a tutorial > > This operation has specific requirements for use. Check out its [workflow](ref:capture-an-image) for details. **Permissions and scopes** To call this operation, you need the following: - **Identity and access permissions**. Your user needs a role with these permissions assigned. [Learn more](https://techdocs.akamai.com/cloud-computing/docs/identity-access-cm-available-roles). - Permissions: `create_image` - **OAuth scopes**. Your user needs these scopes assigned. [Learn more](https://techdocs.akamai.com/linode-api/reference/get-started#oauth). - Scopes: `images:read_write, linodes:read_only` **CLI** ```shell linode-cli images create \ --label this_is_a_label \ --description "A longer description \ of the image" \ --disk_id 123 ``` [Learn more](https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli) - [List images](https://techdocs.akamai.com/linode-api/reference/get-images.md): Returns a paginated list of images. An image can be one of two types: - **Public image**. The `id` for these images begins with `linode/`. These images are generally available to all users. To limit the response to public images, don't include [authentication](ref:get-started#authentication) when calling this operation. - **Private image**. The `id` for these images begins with `private/`. These images are account-specific and only accessible to users with appropriate permissions. To view private images, you need to include authentication when calling this operation. The response includes both private and public images. - **Shared image**. The `id` for these images begins with `shared/`. These are the images that are shared with the user. **Permissions and scopes** To call this operation, you need the following: - **Identity and access permissions**. Your user needs a role with these permissions assigned. [Learn more](https://techdocs.akamai.com/cloud-computing/docs/identity-access-cm-available-roles). - Permissions: `Public images are Internet facing and private images require the view_image permission` - **OAuth scopes**. Your user needs these scopes assigned. [Learn more](https://techdocs.akamai.com/linode-api/reference/get-started#oauth). - Scopes: `images:read_only` **CLI** ```shell linode-cli images list ``` [Learn more](https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli) - [Upload an image](https://techdocs.akamai.com/linode-api/reference/post-upload-image.md): Creates a new private image container and returns a URL as the `upload_to` object in the response. Use this URL to upload your own disk image to the container. > 👍 There's a tutorial > > This operation has specific requirements for use. Check out its [workflow](ref:upload-an-image) for details. **Permissions and scopes** To call this operation, you need the following: - **Identity and access permissions**. Your user needs a role with these permissions assigned. [Learn more](https://techdocs.akamai.com/cloud-computing/docs/identity-access-cm-available-roles). - Permissions: `upload_image` - **OAuth scopes**. Your user needs these scopes assigned. [Learn more](https://techdocs.akamai.com/linode-api/reference/get-started#oauth). - Scopes: `images:read_write` **CLI** ```shell # Run the operation to just get the upload_to URL linode-cli images upload \ --description "Optional details about the Image" \ --label "Example Image" \ --region us-east # Upload the image file in a single step linode-cli image-upload \ --description "Optional details about the Image" \ --label "Example Image" \ --region us-east \ /path/to/image-file.img.gz ``` [Learn more](https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli) - [Get an image](https://techdocs.akamai.com/linode-api/reference/get-image.md): Get information about a single image. An image can be one of two types: - **Public image**. The `id` for these images begins with `linode/`. These images are generally available to all users. To limit the response to public images, don't include [authentication](ref:get-started#authentication) when calling this operation. - **Private image**. The `id` for these images begins with `private/`. These images are account-specific and only accessible to users with appropriate permissions. To view private images, you need to include authentication when calling this operation. The response will also include public images. - **Shared image**. The `id` for these images begins with `shared/`. These are the images that are shared with the user. **Permissions and scopes** To call this operation, you need the following: - **Identity and access permissions**. Your user needs a role with these permissions assigned. [Learn more](https://techdocs.akamai.com/cloud-computing/docs/identity-access-cm-available-roles). - Permissions: `view_image` - **OAuth scopes**. Your user needs these scopes assigned. [Learn more](https://techdocs.akamai.com/linode-api/reference/get-started#oauth). - Scopes: `images:read_only` **CLI** ```shell linode-cli images view linode/debian13 ``` [Learn more](https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli) - [Update an image](https://techdocs.akamai.com/linode-api/reference/put-image.md): Updates a private image. > 📘 > > You can't update the `regions` with this operation. Use the [Replicate an image](ref:post-replicate-image) operation to modify the existing regions for your image. **Permissions and scopes** To call this operation, you need the following: - **Identity and access permissions**. Your user needs a role with these permissions assigned. [Learn more](https://techdocs.akamai.com/cloud-computing/docs/identity-access-cm-available-roles). - Permissions: `update_image` - **OAuth scopes**. Your user needs these scopes assigned. [Learn more](https://techdocs.akamai.com/linode-api/reference/get-started#oauth). - Scopes: `images:read_write` **CLI** ```shell linode-cli images update private/12345 \ --label "My gold image" \ --description "The detailed description \ of my image." ``` [Learn more](https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli) - [Delete an image](https://techdocs.akamai.com/linode-api/reference/delete-image.md): Deletes a private image. > 🚧 > > - You can't undo this delete action. > > - When you delete an image, all [replicated instances](ref:post-replicate-image) of that image are also deleted. **Permissions and scopes** To call this operation, you need the following: - **Identity and access permissions**. Your user needs a role with these permissions assigned. [Learn more](https://techdocs.akamai.com/cloud-computing/docs/identity-access-cm-available-roles). - Permissions: `delete_image` - **OAuth scopes**. Your user needs these scopes assigned. [Learn more](https://techdocs.akamai.com/linode-api/reference/get-started#oauth). - Scopes: `images:read_write` **CLI** ```shell linode-cli images delete 12345 ``` [Learn more](https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli) - [Replicate an image](https://techdocs.akamai.com/linode-api/reference/post-replicate-image.md): Target an existing image and replicate it to another compute region. > 📘 > > As part of our limited promotional period, image replicas are free of charge until November 1, 2025. After this date, replicas will be subject to our standard monthly rate of $0.10/GB. When replicas become billable, your monthly charge will be calculated using the value returned in `total_size`, divided by 100. [Learn more](https://www.linode.com/blog/compute/image-service-improvements-akamai-cdn/). - This is only available in a `region` that supports Object Storage, which stores the replicated image. Run the [List regions](ref:get-regions) operation to review a region's `capabilities`. - To replicate an image, it needs to have a `status` of `available`. Run the [List images](ref:get-images) operation to view an image's `status`. - To also keep the target image in its original compute region, you need to include that `region` in the request's data. If you leave it out, the API removes the image from that region. Run the [Get an image](ref:get-image) operation to see the `regions` where an image currently exists. - You can't include an empty array to delete all images. You need to provide at least one compute `region` where the image is `available`. Use the [Delete an image](ref:delete-image) operation. **Permissions and scopes** To call this operation, you need the following: - **Identity and access permissions**. Your user needs a role with these permissions assigned. [Learn more](https://techdocs.akamai.com/cloud-computing/docs/identity-access-cm-available-roles). - Permissions: `replicate_image` - **OAuth scopes**. Your user needs these scopes assigned. [Learn more](https://techdocs.akamai.com/linode-api/reference/get-started#oauth). - Scopes: `images:read_write` **CLI** ```shell linode-cli images replicate private/12345 \ --regions "us-mia" \ --regions "us-east" ``` [Learn more](https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli) - [Create a Linode](https://techdocs.akamai.com/linode-api/reference/post-linode-instance.md): Creates a new Linode instance on your account. This incurs a charge on your account. - There are several types of Linode you can choose from. Each provides a different size, processing potential, and cost. Run the [List Linode types](ref:get-linode-types) operation for information on each available type. - You can create a Linode in any available regions. Run the [List regions](ref:get-regions) operation to see what's available. - You need to provide at least one authentication mechanism for disk access: a `root_pass`, `authorized_keys`, or `authorized_users`, with the latter two offering SSH protection. - To fight spam, Akamai restricts outbound connections on ports 25, 465, and 587 on all Linodes. For more information, see our guide on [Running a Mail Server](https://www.linode.com/docs/guides/running-a-mail-server/). - To add or modify `tags` on a Linode, your account [user](ref:get-users) needs `read-write` access for **Linode instances** and **Tags** operations. Talk to your local account administrator about access management. There are several ways to create a Linode, using the objects available in this operation: **Use an Image** This includes using a Linode public image distribution or a private image that you created, based on another Linode. > 👍 There are tutorials > > We offer example API workflows you can follow for both [public image distributions](ref:create-a-linode-using-a-public-image) as well as [private images](ref:create-a-linode-using-a-private-image). **Use cloud-init** Our cloud-init solution with [Metadata](https://www.linode.com/docs/products/compute/compute-instances/guides/metadata/) automates system configuration and software installation by providing a base-64 encoded [cloud-config](https://www.linode.com/docs/products/compute/compute-instances/guides/metadata-cloud-config/) file. - You need a compatible image. To check for compatibility, run the [List images](ref:get-images) operation and check for `cloud-init` under `capabilities`. - This also requires a compatible region. Run the [List regions](ref:get-regions) operation and look for `Metadata` under `capabilities` for a specific `region`. **Use a StackScript** You can use a StackScript to automate deployment of new systems, through a customized script. > 👍 There's a tutorial > > We offer an example API workflow you can follow to create a new Linode [using a StackScript](ref:create-a-linode-using-a-stackscript). **Use a Linode backup** You can create a backup of an existing Linode and restore it to a new one. > 👍 There's a tutorial > > We offer an example API workflow you can follow to create a new Linode [using a backup](ref:create-a-linode-using-a-backup). **Create an empty Linode** - Use this operation to create a new one. - The Linode will remain `offline` and you need to manually start it. Run the [Boot a Linode](ref:post-boot-linode-instance) operation. - Manually create the Linode's [disks](ref:post-add-linode-disk) and [configuration profiles](ref:post-add-linode-config) (legacy) or [configuration profile interfaces](ref:post-linode-config-interface). > 📘 > > You should only use this method for advanced use cases. **Linodes and interfaces** Depending on your [account settings](ref:get-account-settings), you can choose between legacy configuration interfaces or Linode interfaces when creating a Linode. Only one type of interface is allowed per Linode. The `interface_generation` field lets you select one interface type for new Linodes when both legacy and Linode interfaces options are available on your account. If a Linode is configured with a Linode interface, legacy configuration interfaces can no longer be used on that Linode. **Permissions and scopes** To call this operation, you need the following: - **Identity and access permissions**. Your user needs a role with these permissions assigned. [Learn more](https://techdocs.akamai.com/cloud-computing/docs/identity-access-cm-available-roles). - Permissions: `create_linode` - **OAuth scopes**. Your user needs these scopes assigned. [Learn more](https://techdocs.akamai.com/linode-api/reference/get-started#oauth). - Scopes: `linodes:read_write` **CLI** ```shell linode-cli linodes create \ --label linode123 \ --root_pass aComplex@Password \ --booted true \ --stackscript_id 10079 \ --stackscript_data '{"gh_username": "linode"}' \ --region us-east \ --disk_encryption enabled\ --placement_group.id 528 \ --type g6-standard-2 \ --authorized_keys "ssh-rsa AAAA_valid_public_ssh_key_123456785== user@their-computer" \ --authorized_users "myUser" \ --authorized_users "secondaryUser" \ --metadata.user_data "I2Nsb3VkLWNvbmZpZw==" \ --firewall_id 9000 \ --ipv4 "192.0.2.141" ``` [Learn more](https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli) - [List Linodes](https://techdocs.akamai.com/linode-api/reference/get-linode-instances.md): Returns all Linodes you have permission to view. **Permissions and scopes** To call this operation, you need the following: - **Identity and access permissions**. Your user needs a role with these permissions assigned. [Learn more](https://techdocs.akamai.com/cloud-computing/docs/identity-access-cm-available-roles). - Permissions: `view_linode` - **OAuth scopes**. Your user needs these scopes assigned. [Learn more](https://techdocs.akamai.com/linode-api/reference/get-started#oauth). - Scopes: `linodes:read_only` **CLI** ```shell linode-cli linodes list ``` [Learn more](https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli) - [Get a Linode](https://techdocs.akamai.com/linode-api/reference/get-linode-instance.md): Get a specific Linode based on its unique `id`. **Permissions and scopes** To call this operation, you need the following: - **Identity and access permissions**. Your user needs a role with these permissions assigned. [Learn more](https://techdocs.akamai.com/cloud-computing/docs/identity-access-cm-available-roles). - Permissions: `view_linode` - **OAuth scopes**. Your user needs these scopes assigned. [Learn more](https://techdocs.akamai.com/linode-api/reference/get-started#oauth). - Scopes: `linodes:read_only` **CLI** ```shell linode-cli linodes view 123 ``` [Learn more](https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli) - [Update a Linode](https://techdocs.akamai.com/linode-api/reference/put-linode-instance.md): Updates a Linode. > 📘 Updating `tags`? > > If you include the `tags` object in this operation to modify the Linode's tags, you need to include existing `tags` to maintain them. You can run the [List tagged objects](ref:get-tagged-objects) operation to view your Linode, based on its `label` and store its current `tags`. **Permissions and scopes** To call this operation, you need the following: - **Identity and access permissions**. Your user needs a role with these permissions assigned. [Learn more](https://techdocs.akamai.com/cloud-computing/docs/identity-access-cm-available-roles). - Permissions: `update_linode` - **OAuth scopes**. Your user needs these scopes assigned. [Learn more](https://techdocs.akamai.com/linode-api/reference/get-started#oauth). - Scopes: `linodes:read_write` **CLI** ```shell linode-cli linodes update 7833080 \ --label linode123 \ --backups.schedule.day "Saturday" \ --backups.schedule.window "W22" \ --alerts.cpu 180 \ --alerts.network_in 10 \ --alerts.network_out 10 \ --alerts.transfer_quota 80 \ --alerts.io 10000 ``` [Learn more](https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli) - [Delete a Linode](https://techdocs.akamai.com/linode-api/reference/delete-linode-instance.md): Deletes a Linode. > 🚧 > > Deleting a Linode is a destructive action and can't be undone. Consider these points before deleting a Linode: - Any unreserved (ephemeral) IP addresses assigned to the Linode are given up. Reserved IP addresses remain on your account and available to assign to another Linode or NodeBalancer within the same region. Reserved IP fees remain active as long as the address is held on your account, regardless of its assignment status. - All disks, backups, configuration profiles, and interfaces assigned to the Linode are also are deleted. - Any Block Storage volumes assigned to the Linode are detached. - Billing for the Linode and its associated services stops. You're billed for time used within the billing period the Linode was active. - You can't delete a Linode that's currently being [cloned](ref:post-clone-linode-instance) or [restored from a backup](ref:post-restore-backup). - You can't delete a Linode that has a `cannot_delete` or `cannot_delete_with_subresources` [resource lock](ref:post-resource-lock) set for it. **Permissions and scopes** To call this operation, you need the following: - **Identity and access permissions**. Your user needs a role with these permissions assigned. [Learn more](https://techdocs.akamai.com/cloud-computing/docs/identity-access-cm-available-roles). - Permissions: `delete_linode` - **OAuth scopes**. Your user needs these scopes assigned. [Learn more](https://techdocs.akamai.com/linode-api/reference/get-started#oauth). - Scopes: `linodes:read_write` **CLI** ```shell linode-cli linodes delete 123 ``` [Learn more](https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli) - [Boot a Linode](https://techdocs.akamai.com/linode-api/reference/post-boot-linode-instance.md): Boots a Linode you have permission to modify. If the Linode is using config profiles, and no parameters are given, a config profile is chosen for this boot based on the following criteria: - If there is only one config profile for this Linode, it will be used. - If there is more than one config profile, the last booted config will be used. - If there is more than one config profile and none were the last to be booted (because the Linode was never booted or the last booted config was deleted) an error will be returned. If the Linode is using Linode interfaces, where `interface_generation` is set as `linode`, an error is returned if the Linode has to boot without any interface defined. **Permissions and scopes** To call this operation, you need the following: - **Identity and access permissions**. Your user needs a role with these permissions assigned. [Learn more](https://techdocs.akamai.com/cloud-computing/docs/identity-access-cm-available-roles). - Permissions: `boot_linode` - **OAuth scopes**. Your user needs these scopes assigned. [Learn more](https://techdocs.akamai.com/linode-api/reference/get-started#oauth). - Scopes: `linodes:read_write` **CLI** ```shell linode-cli linodes boot 123 ``` [Learn more](https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli) - [Clone a Linode](https://techdocs.akamai.com/linode-api/reference/post-clone-linode-instance.md): Clone your Linode's existing disks, configuration profiles, and interfaces to another Linode on your account. Consider these points before cloning a Linode: - Cloning to a new Linode incurs a charge on your account. - If cloning to an existing Linode, any actions currently running or queued need to finish before you can clone to it. - You can run up to five concurrent clone operations, from a single Linode. If you exceed this limit, you'll receive an HTTP 400 error. - For Linodes using Linode interfaces, the region where you want the clone to live also needs to support Linode interfaces. You can run the [GET a region](ref:get-region) operation to see what's supported. Your user's [account settings](ref:get-account-settings) also need ot be set to allow creation of Linodes with Linode interfaces. - Any [tags](ref:get-tags) you have set on your source Linode will be cloned to the target Linode. - If your source Linode is protected with a resource lock, the lock is _not included_ on the clone. You'll need to [add a new resource lock](ref:post-resource-lock) if you want to protect the clone. - If the target Linode uses Metadata, with `has_user_data` set to `true`, you need to create the clone with `metadata.user_data` in the request. - If the target Linode has a `vpc` interface on its active legacy configuration profile, and it includes a `1:1 NAT`, the resulting clone is configured with an `any` 1:1 NAT. See the [VPC documentation](https://www.linode.com/docs/products/networking/vpc/#technical-specifications) guide for its specifications and limitations. - Only next generation network (NGN) data centers (regions) support VLANs. If a VLAN is attached to your Linode and you try to clone it to a non-NGN region, the clone won't start. If a Linode can't be cloned because of an incompatibility, you're prompted to select a different region or contact support. See the [VLANs Overview](https://www.linode.com/docs/products/networking/vlans/#technical-specifications) guide for more specifications and limitations. **Permissions and scopes** To call this operation, you need the following: - **Identity and access permissions**. Your user needs a role with these permissions assigned. [Learn more](https://techdocs.akamai.com/cloud-computing/docs/identity-access-cm-available-roles). - Permissions: `clone_linode` - **OAuth scopes**. Your user needs these scopes assigned. [Learn more](https://techdocs.akamai.com/linode-api/reference/get-started#oauth). - Scopes: `linodes:read_write` **CLI** ```shell linode-cli linodes clone 123 \ --linode_id 124 \ --region us-east \ --type g6-standard-2 \ --label cloned-linode \ --backups_enabled true \ --placement_group.id 528 \ --disks 25674 \ --configs 23456 \ --private_ip true \ --metadata.user_data I2Nsb3VkLWNvbmZpZw== ``` [Learn more](https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli) - [Migrate a Linode](https://techdocs.akamai.com/linode-api/reference/post-migrate-linode-instance.md): Use this operation to move a Linode. There are two types of migration you can perform: * **Migrate to a new data center**. This applies when you want to move your Linode from one data center to another. You need to include the desired `region` for the new data center in the request. Run the [List regions](ref:get-regions) operation to see all available regions and their feature capabilities. Also, see our [pricing page](https://www.akamai.com/cloud/pricing) for region-specific pricing, which applies after migration is complete. * **Initiate a pending host migration**. This applies to a migration that Akamai has scheduled for your Linode. Run the [List notifications](ref:get-notifications) operation to see any pending host migrations. When the migration begins, the API shuts down the Linode if it's not already off. If the migration initiated the shutdown, the API reboots the Linode when completed. Consider these points before starting any migration: - You can't migrate a Linode to a new data center when that Linode has a `vpc` purpose, legacy configuration interface or a VPC Linode interface. Either of these situations can only be migrated within the same data center. See the [VPC documentation](https://www.linode.com/docs/products/networking/vpc/#technical-specifications) guide for its specifications and limitations. - Only next generation network (NGN) data centers support VLANs. Run the [List regions](ref:get-regions) operation to view the capabilities of each data center. If a VLAN is attached to your Linode and you try to migrate or clone it to a non-NGN data center, the operation won't initiate. If a Linode can't be migrated or cloned because of an incompatibility, you'll be prompted to select a different data center or contact support. - NGN data centers don't support IPv6 `/116` pools or IP Failover. If you have these features enabled on your Linode and try to migrate to an NGN data center, the migration won't initiate. If a Linode can't be migrated because of an incompatibility, you'll be prompted to select a different data center or contact support. See the [VLANs Overview](https://www.linode.com/docs/products/networking/vlans/#technical-specifications) guide to view additional specifications and limitations. - If the Linode is using a public Linode interface, the destination region needs to also support Linode interfaces. Run the [List regions](ref:get-regions) operation to see their feature capabilities. - After migrating to a different data center, Linode public interfaces retain the same number of IP addresses, but the IP addresses themselves change. **Permissions and scopes** To call this operation, you need the following: - **Identity and access permissions**. Your user needs a role with these permissions assigned. [Learn more](https://techdocs.akamai.com/cloud-computing/docs/identity-access-cm-available-roles). - Permissions: `migrate_linode` - **OAuth scopes**. Your user needs these scopes assigned. [Learn more](https://techdocs.akamai.com/linode-api/reference/get-started#oauth). - Scopes: `linodes:read_write` **CLI** ```shell linode-cli linodes migrate 123 \ --region us-central \ --placement_group.id 528 ``` [Learn more](https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli) - [Upgrade a Linode](https://techdocs.akamai.com/linode-api/reference/post-mutate-linode-instance.md): Linodes created with now-deprecated Types are entitled to a free upgrade to the next generation. A mutating Linode will be allocated any new resources the upgraded Type provides, and will be subsequently restarted if it was currently running. If any actions are currently running or queued, those actions must be completed first before you can initiate a mutate. **Permissions and scopes** To call this operation, you need the following: - **Identity and access permissions**. Your user needs a role with these permissions assigned. [Learn more](https://techdocs.akamai.com/cloud-computing/docs/identity-access-cm-available-roles). - Permissions: `upgrade_linode` - **OAuth scopes**. Your user needs these scopes assigned. [Learn more](https://techdocs.akamai.com/linode-api/reference/get-started#oauth). - Scopes: `linodes:read_write` **CLI** ```shell linode-cli linodes upgrade 123 ``` [Learn more](https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli) - [Reset a Linode's root password](https://techdocs.akamai.com/linode-api/reference/post-reset-linode-password.md): Resets the root password for this Linode. - Your Linode must be [shut down](ref:post-shutdown-linode-instance) for a password reset to complete. - If your Linode has more than one disk (not counting its swap disk), run the [Reset a disk root password](ref:post-reset-disk-password) operation to update a specific disk's root password. - A `password_reset` event is generated when a root password reset is successful. **Permissions and scopes** To call this operation, you need the following: - **Identity and access permissions**. Your user needs a role with these permissions assigned. [Learn more](https://techdocs.akamai.com/cloud-computing/docs/identity-access-cm-available-roles). - Permissions: `password_reset_linode` - **OAuth scopes**. Your user needs these scopes assigned. [Learn more](https://techdocs.akamai.com/linode-api/reference/get-started#oauth). - Scopes: `linodes:read_write` **CLI** ```shell linode-cli linodes linode-reset-password 123 a$eCure4assw0rd!43v51 ``` [Learn more](https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli) - [Reboot a Linode](https://techdocs.akamai.com/linode-api/reference/post-reboot-linode-instance.md): Reboots a Linode you have permission to modify. If any actions are currently running or queued, those actions must be completed first before you can initiate a reboot. If the Linode is using Linode interfaces, where `interface_generation` is set as `linode`, an error is returned if the Linode has to reboot without any interface defined. **Permissions and scopes** To call this operation, you need the following: - **Identity and access permissions**. Your user needs a role with these permissions assigned. [Learn more](https://techdocs.akamai.com/cloud-computing/docs/identity-access-cm-available-roles). - Permissions: `reboot_linode` - **OAuth scopes**. Your user needs these scopes assigned. [Learn more](https://techdocs.akamai.com/linode-api/reference/get-started#oauth). - Scopes: `linodes:read_write` **CLI** ```shell linode-cli linodes reboot 123 ``` [Learn more](https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli) - [Rebuild a Linode](https://techdocs.akamai.com/linode-api/reference/post-rebuild-linode-instance.md): Rebuild an existing Linode. A rebuild shuts down the Linode, deletes all of its disks and configuration profiles, then deploys a new `image` to the Linode with the given attributes. Consider these points before rebuilding a Linode: - You need to supply an `image` for use in rebuilding the Linode. This can be a [private image](ref:create-a-linode-using-a-private-image) you've created or uploaded, or a [public image](ref:create-a-linode-using-a-public-image) we offer. - You need to provide at least one authentication mechanism for disk access: a `root_pass`, `authorized_keys`, or `authorized_users`, with the latter two offering SSH protection. - If your target Linode currently uses Metadata (`"has_user_data": true`), you should include `metadata.user_data` in the rebuild request to continue using the service. - Linode interfaces don't change during a rebuild. - During a rebuild, you can `enable` or `disable` local disk encryption. If disk encryption is not included in the request, the previous `disk_encryption` value is used. You can't disable disk encryption if the target Linode is attached to a LKE nodepool. - You can resize the Linode to a different plan by including the `type` parameter, and setting it to a lesser plan. Consider the following points before resizing: - You can't have an outstanding balance on your account. - Resizing during a rebuild requires significantly more time. - If you resize, the Linode will be migrated to a new hardware host, while rebuilding without resizing keeps the same hardware host. - If any actions are currently running or queued for the Linode, you need to wait for them to complete. - The Linode can't be pending migration. - The Linode can't have more disk allocation than the new `type` supports. If this is the case, you need to delete or resize the disk to be smaller. - You can [resize a Linode](ref:post-resize-linode-instance) using a separate operation. - If you have Block Storage volumes [attached](ref:post-attach-volume) to the Linode, you can't resize it to a `type` that supports fewer volumes. You need to delete volumes from the Linode to meet the limit supported by the smaller `type`. **Permissions and scopes** To call this operation, you need the following: - **Identity and access permissions**. Your user needs a role with these permissions assigned. [Learn more](https://techdocs.akamai.com/cloud-computing/docs/identity-access-cm-available-roles). - Permissions: `rebuild_linode` - **OAuth scopes**. Your user needs these scopes assigned. [Learn more](https://techdocs.akamai.com/linode-api/reference/get-started#oauth). - Scopes: `linodes:read_write` **CLI** ```shell linode-cli linodes rebuild 123 \ --image "linode/debian13" \ --root_pass aComplex@Password \ --disk_encryption disabled \ --authorized_keys "ssh-rsa AAAA_valid_public_ssh_key_123456785== user@their-computer" \ --authorized_users "myUsername" \ --authorized_users "secondaryUsername" \ --booted true \ --stackscript_id 10079 \ --stackscript_data '{"gh_username": "linode"}' \ --type "g6-standard-2" \ --metadata.userdata "I2Nsb3VkLWNvbmZpZw==" ``` [Learn more](https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli) - [Boot a Linode into rescue mode](https://techdocs.akamai.com/linode-api/reference/post-rescue-linode-instance.md): Rescue Mode is a safe environment for performing many system recovery and disk management tasks. Rescue Mode is based on the Finnix recovery distribution, a self-contained and bootable Linux distribution. You can also use Rescue Mode for tasks other than disaster recovery, such as formatting disks to use different filesystems, copying data between disks, and downloading files from a disk via SSH and SFTP. Linodes with legacy configuration interfaces receive a public IP and boot into the recovery Linux distribution. Linodes with Linode interfaces still boot into recovery mode with the recovery Linux distribution, but they retain their original network interfaces and settings from before entering rescue mode. - Note that `sdh` is reserved and unavailable during rescue. **Permissions and scopes** To call this operation, you need the following: - **Identity and access permissions**. Your user needs a role with these permissions assigned. [Learn more](https://techdocs.akamai.com/cloud-computing/docs/identity-access-cm-available-roles). - Permissions: `rescue_linode` - **OAuth scopes**. Your user needs these scopes assigned. [Learn more](https://techdocs.akamai.com/linode-api/reference/get-started#oauth). - Scopes: `linodes:read_write` **CLI** ```shell linode-cli linodes rescue 123 \ --devices.sda.disk_id 124458 ``` [Learn more](https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli) - [Resize a Linode](https://techdocs.akamai.com/linode-api/reference/post-resize-linode-instance.md): Resize a Linode to a different plan (`type`). Consider these points before resizing: - You can't have an outstanding balance on your account. - If any actions are currently running or queued for the Linode, you need to wait for them to complete before you can resize it. - The Linode can't be pending migration. - The Linode can't have more disk allocation than what the new `type` supports. If this is the case, you need to delete or resize the disk to be smaller. - You can also resize a Linode when using the [Rebuild a Linode](ref:post-rebuild-linode-instance) operation. - If you have Block Storage volumes [attached](ref:post-attach-volume) to the Linode, you can't resize it to a `type` that supports fewer volumes. You need to delete volumes from the Linode to meet the limit supported by the smaller `type`. **Permissions and scopes** To call this operation, you need the following: - **Identity and access permissions**. Your user needs a role with these permissions assigned. [Learn more](https://techdocs.akamai.com/cloud-computing/docs/identity-access-cm-available-roles). - Permissions: `resize_linode` - **OAuth scopes**. Your user needs these scopes assigned. [Learn more](https://techdocs.akamai.com/linode-api/reference/get-started#oauth). - Scopes: `linodes:read_write` **CLI** ```shell linode-cli linodes resize 123 \ --type g6-standard-2 ``` [Learn more](https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli) - [Shut down a Linode](https://techdocs.akamai.com/linode-api/reference/post-shutdown-linode-instance.md): Shuts down a Linode you have permission to modify. If any actions are currently running or queued, those actions must be completed first before you can initiate a shutdown. **Permissions and scopes** To call this operation, you need the following: - **Identity and access permissions**. Your user needs a role with these permissions assigned. [Learn more](https://techdocs.akamai.com/cloud-computing/docs/identity-access-cm-available-roles). - Permissions: `shutdown_linode` - **OAuth scopes**. Your user needs these scopes assigned. [Learn more](https://techdocs.akamai.com/linode-api/reference/get-started#oauth). - Scopes: `linodes:read_write` **CLI** ```shell linode-cli linodes shutdown 123 ``` [Learn more](https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli) - [List types](https://techdocs.akamai.com/linode-api/reference/get-linode-types.md): Returns Linode types, including pricing and specifications for each. Use these when [creating](ref:post-linode-instance) or [resizing](ref:post-resize-linode-instance) Linodes. **Permissions and scopes** To call this operation, you need the following: - **Identity and access permissions**. This operation is internet-facing. No permissions are required. **CLI** ```shell linode-cli linodes types ``` [Learn more](https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli) - [Get a type](https://techdocs.akamai.com/linode-api/reference/get-linode-type.md): Returns information about a specific Linode type, including pricing and specifications. This is used when [creating](ref:post-linode-instance) or [resizing](ref:post-resize-linode-instance) Linodes. **Permissions and scopes** To call this operation, you need the following: - **Identity and access permissions**. This operation is internet-facing. No permissions are required. **CLI** ```shell linode-cli linodes type-view g6-standard-2 ``` [Learn more](https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli) - [List Linode NodeBalancers](https://techdocs.akamai.com/linode-api/reference/get-linode-node-balancers.md): Returns a list of NodeBalancers that are assigned to this Linode and readable by the requesting User. **Permissions and scopes** To call this operation, you need the following: - **Identity and access permissions**. Your user needs a role with these permissions assigned. [Learn more](https://techdocs.akamai.com/cloud-computing/docs/identity-access-cm-available-roles). - Permissions: `list_linode_nodebalancers` - **OAuth scopes**. Your user needs these scopes assigned. [Learn more](https://techdocs.akamai.com/linode-api/reference/get-started#oauth). - Scopes: `linodes:read_only` **CLI** ```shell linode-cli linodes nodebalancers 123 ``` [Learn more](https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli) - [List a Linode's volumes](https://techdocs.akamai.com/linode-api/reference/get-linode-volumes.md): View the Block Storage volumes attached to this Linode. **Permissions and scopes** To call this operation, you need the following: - **Identity and access permissions**. Your user needs a role with these permissions assigned. [Learn more](https://techdocs.akamai.com/cloud-computing/docs/identity-access-cm-available-roles). - Permissions: `list_linode_volumes` - **OAuth scopes**. Your user needs these scopes assigned. [Learn more](https://techdocs.akamai.com/linode-api/reference/get-started#oauth). - Scopes: `linodes:read_only` **CLI** ```shell linode-cli linodes volumes 123 ``` [Learn more](https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli) - [Create a snapshot](https://techdocs.akamai.com/linode-api/reference/post-snapshot.md): Creates a snapshot backup of a Linode. > 📘 > > - Backups aren't encrypted even when they're taken from an encrypted disk. When a backup is restored, and if encryption is enabled, the data stored on the disk is encrypted again. > > - If you already have a snapshot of this Linode, the previous snapshot will be deleted. **Permissions and scopes** To call this operation, you need the following: - **Identity and access permissions**. Your user needs a role with these permissions assigned. [Learn more](https://techdocs.akamai.com/cloud-computing/docs/identity-access-cm-available-roles). - Permissions: `create_linode_backup_snapshot` - **OAuth scopes**. Your user needs these scopes assigned. [Learn more](https://techdocs.akamai.com/linode-api/reference/get-started#oauth). - Scopes: `linodes:read_write` **CLI** ```shell linode-cli linodes snapshot 123 ``` [Learn more](https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli) - [List backups](https://techdocs.akamai.com/linode-api/reference/get-backups.md): Returns information about this Linode's available backups. **Permissions and scopes** To call this operation, you need the following: - **Identity and access permissions**. Your user needs a role with these permissions assigned. [Learn more](https://techdocs.akamai.com/cloud-computing/docs/identity-access-cm-available-roles). - Permissions: `view_linode` - **OAuth scopes**. Your user needs these scopes assigned. [Learn more](https://techdocs.akamai.com/linode-api/reference/get-started#oauth). - Scopes: `linodes:read_only` **CLI** ```shell linode-cli linodes backups-list 123 ``` [Learn more](https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli) - [Cancel backups](https://techdocs.akamai.com/linode-api/reference/post-cancel-backups.md): Cancels the Backup service on the given Linode. Deletes all of this Linode's existing backups forever. **Permissions and scopes** To call this operation, you need the following: - **Identity and access permissions**. Your user needs a role with these permissions assigned. [Learn more](https://techdocs.akamai.com/cloud-computing/docs/identity-access-cm-available-roles). - Permissions: `cancel_linode_backups` - **OAuth scopes**. Your user needs these scopes assigned. [Learn more](https://techdocs.akamai.com/linode-api/reference/get-started#oauth). - Scopes: `linodes:read_write` **CLI** ```shell linode-cli linodes backups-cancel 123 ``` [Learn more](https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli) - [Enable backups](https://techdocs.akamai.com/linode-api/reference/post-enable-backups.md): Enables backups for the specified Linode. > 📘 > > Backups aren't encrypted even when they're taken from an encrypted disk. When a backup is restored, and if encryption is enabled, the data stored on the disk is encrypted again. **Permissions and scopes** To call this operation, you need the following: - **Identity and access permissions**. Your user needs a role with these permissions assigned. [Learn more](https://techdocs.akamai.com/cloud-computing/docs/identity-access-cm-available-roles). - Permissions: `enable_linode_backups` - **OAuth scopes**. Your user needs these scopes assigned. [Learn more](https://techdocs.akamai.com/linode-api/reference/get-started#oauth). - Scopes: `linodes:read_write` **CLI** ```shell linode-cli linodes backups-enable 123 ``` [Learn more](https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli) - [Get a backup](https://techdocs.akamai.com/linode-api/reference/get-backup.md): Returns information about a Backup. **Permissions and scopes** To call this operation, you need the following: - **Identity and access permissions**. Your user needs a role with these permissions assigned. [Learn more](https://techdocs.akamai.com/cloud-computing/docs/identity-access-cm-available-roles). - Permissions: `view_linode_backup` - **OAuth scopes**. Your user needs these scopes assigned. [Learn more](https://techdocs.akamai.com/linode-api/reference/get-started#oauth). - Scopes: `linodes:read_only` **CLI** ```shell linode-cli linodes backup-view 123 123456 ``` [Learn more](https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli) - [Restore a backup](https://techdocs.akamai.com/linode-api/reference/post-restore-backup.md): Restores a Linode's backup to the specified Linode. - Backups can't be restored across regions. - You can only restore a successfully completed backup that is not under maintenance. - The Linode that the backup is being restored to can't be the target of a current backup. When you restore a backup, the restored disk is assigned the same [UUID](https://en.wikipedia.org/wiki/Universally_unique_identifier) as the original disk. In most cases, this is acceptable and doesn't cause issues. However, if you try to mount both the original disk and the corresponding restore disk at the same time (by assigning them both to devices in your Configuration Profile's __Block Device Assignment__), you'll encounter a UUID "collision". When this happens, the system selects, and mounts, only one of the disks at random. This is because both disks are sharing the same UUID. Your instance _may fail to boot_ because the API can't tell which disk is root. If your system boots in this scenario, you won't see an immediate indication if you're booted into the restored disk or the original disk, and you'll be unable to access both disks at the same time. To avoid this, only restore a backup to the same Linode if you don't intend to mount them at the same time, or you're comfortable modifying UUIDs. If you need access to files on both the original disk and the restored disk simultaneously -- for example, if you need to copy files between them -- you should restore the backup to a separate Linode or [create](ref:post-linode-instance) a new Linode using the desired `backup_id`. To learn more about block device assignments and viewing your disks' UUIDs, see our guide on [Configuration Profiles](https://www.linode.com/docs/products/compute/compute-instances/guides/configuration-profiles/#block-device-assignment). > 📘 > > Backups aren't encrypted even when they're taken from an encrypted disk. When a backup is restored, and if encryption is enabled, the data stored on the disk is encrypted again. **Permissions and scopes** To call this operation, you need the following: - **Identity and access permissions**. Your user needs a role with these permissions assigned. [Learn more](https://techdocs.akamai.com/cloud-computing/docs/identity-access-cm-available-roles). - Permissions: `restore_linode_backup` - **OAuth scopes**. Your user needs these scopes assigned. [Learn more](https://techdocs.akamai.com/linode-api/reference/get-started#oauth). - Scopes: `linodes:read_write` **CLI** ```shell linode-cli linodes backup-restore 123 123456 \ --linode_id 234 \ --overwrite true ``` [Learn more](https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli) - [Create a configuration profile](https://techdocs.akamai.com/linode-api/reference/post-add-linode-config.md): Adds a new configuration profile to a Linode. Configuration profiles define the kernel, devices, and how much memory a Linode boots with. > 📘 > > This operation is for legacy configuration profiles only, and not [Linode interfaces](ref:post-linode-interface). **Permissions and scopes** To call this operation, you need the following: - **Identity and access permissions**. Your user needs a role with these permissions assigned. [Learn more](https://techdocs.akamai.com/cloud-computing/docs/identity-access-cm-available-roles). - Permissions: `create_linode_config_profile` - **OAuth scopes**. Your user needs these scopes assigned. [Learn more](https://techdocs.akamai.com/linode-api/reference/get-started#oauth). - Scopes: `linodes:read_write` **CLI** ```shell linode-cli linodes config-create 7590910 \ --label "My Config" \ --devices.sda.disk_id 123456 \ --devices.sdb.disk_id 123457 ``` [Learn more](https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli) - [List configuration profiles](https://techdocs.akamai.com/linode-api/reference/get-linode-configs.md): Lists configuration profiles associated with a Linode. **Permissions and scopes** To call this operation, you need the following: - **Identity and access permissions**. Your user needs a role with these permissions assigned. [Learn more](https://techdocs.akamai.com/cloud-computing/docs/identity-access-cm-available-roles). - Permissions: `view_linode` - **OAuth scopes**. Your user needs these scopes assigned. [Learn more](https://techdocs.akamai.com/linode-api/reference/get-started#oauth). - Scopes: `linodes:read_only` **CLI** ```shell linode-cli linodes configs-list 123 ``` [Learn more](https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli) - [Get a configuration profile](https://techdocs.akamai.com/linode-api/reference/get-linode-config.md): Returns information about a specific configuration profile. **Permissions and scopes** To call this operation, you need the following: - **Identity and access permissions**. Your user needs a role with these permissions assigned. [Learn more](https://techdocs.akamai.com/cloud-computing/docs/identity-access-cm-available-roles). - Permissions: `view_linode_config_profile` - **OAuth scopes**. Your user needs these scopes assigned. [Learn more](https://techdocs.akamai.com/linode-api/reference/get-started#oauth). - Scopes: `linodes:read_only` **CLI** ```shell linode-cli linodes config-view 123 23456 ``` [Learn more](https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli) - [Update a configuration profile](https://techdocs.akamai.com/linode-api/reference/put-linode-config.md): Updates a configuration profile. **Permissions and scopes** To call this operation, you need the following: - **Identity and access permissions**. Your user needs a role with these permissions assigned. [Learn more](https://techdocs.akamai.com/cloud-computing/docs/identity-access-cm-available-roles). - Permissions: `update_linode_config_profile` - **OAuth scopes**. Your user needs these scopes assigned. [Learn more](https://techdocs.akamai.com/linode-api/reference/get-started#oauth). - Scopes: `linodes:read_write` **CLI** ```shell linode-cli linodes config-update 123 23456 \ --kernel "linode/latest-64bit" \ --comments "This is my main Config" \ --memory_limit 2048 \ --run_level default \ --virt_mode paravirt \ --helpers.updatedb_disabled true \ --helpers.distro true \ --helpers.modules_dep true \ --helpers.network true \ --helpers.devtmpfs_automount false \ --label "My Config" \ --devices.sda.disk_id 123456 \ --devices.sdb.disk_id 123457 ``` [Learn more](https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli) - [Delete a configuration profile](https://techdocs.akamai.com/linode-api/reference/delete-linode-config.md): Delete a specific configuration profile from the specified Linode. You can't delete a configuration profile from a Linode that has a `cannot_delete_with_subresources` [resource lock](ref:post-resource-lock) set for it. **Permissions and scopes** To call this operation, you need the following: - **Identity and access permissions**. Your user needs a role with these permissions assigned. [Learn more](https://techdocs.akamai.com/cloud-computing/docs/identity-access-cm-available-roles). - Permissions: `delete_linode_config_profile` - **OAuth scopes**. Your user needs these scopes assigned. [Learn more](https://techdocs.akamai.com/linode-api/reference/get-started#oauth). - Scopes: `linodes:read_write` **CLI** ```shell linode-cli linodes config-delete 123 23456 ``` [Learn more](https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli) - [Add a configuration profile interface](https://techdocs.akamai.com/linode-api/reference/post-linode-config-interface.md): Creates and appends a single interface to the end of the `interfaces` array for an existing configuration profile. After you add the interface, you need to reboot the target Linode. - A successful request triggers a `linode_config_update` [event](ref:get-events). - Only one interface can be set as `primary`. Setting `primary` to `true` for an interface sets all other interfaces to `false`. **Permissions and scopes** To call this operation, you need the following: - **Identity and access permissions**. Your user needs a role with these permissions assigned. [Learn more](https://techdocs.akamai.com/cloud-computing/docs/identity-access-cm-available-roles). - Permissions: `create_linode_config_profile_interface` - **OAuth scopes**. Your user needs these scopes assigned. [Learn more](https://techdocs.akamai.com/linode-api/reference/get-started#oauth). - Scopes: `linodes:read_write` **CLI** ```shell linode-cli linodes config-interface-add $linodeId $configId \ --purpose vpc \ --primary false \ --subnet_id 101 \ --ipv4.vpc "10.0.1.2" \ --ipv4.nat_1_1 "203.0.113.2" ``` [Learn more](https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli) - [List configuration profile interfaces](https://techdocs.akamai.com/linode-api/reference/get-linode-config-interfaces.md): Returns all configuration profile interfaces assigned to a specific configuration profile, on a specific Linode. **Permissions and scopes** To call this operation, you need the following: - **Identity and access permissions**. Your user needs a role with these permissions assigned. [Learn more](https://techdocs.akamai.com/cloud-computing/docs/identity-access-cm-available-roles). - Permissions: `view_linode_config_profile_interface` - **OAuth scopes**. Your user needs these scopes assigned. [Learn more](https://techdocs.akamai.com/linode-api/reference/get-started#oauth). - Scopes: `linodes:read_only` **CLI** ```shell linode-cli linodes config-interfaces-list $linodeId $configId ``` [Learn more](https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli) - [Reorder configuration profile interfaces](https://techdocs.akamai.com/linode-api/reference/post-linode-config-interfaces.md): Reorders the existing Interfaces of a Configuration Profile. **Permissions and scopes** To call this operation, you need the following: - **Identity and access permissions**. Your user needs a role with these permissions assigned. [Learn more](https://techdocs.akamai.com/cloud-computing/docs/identity-access-cm-available-roles). - Permissions: `reorder_linode_config_profile_interfaces` - **OAuth scopes**. Your user needs these scopes assigned. [Learn more](https://techdocs.akamai.com/linode-api/reference/get-started#oauth). - Scopes: `linodes:read_write` **CLI** ```shell linode-cli linodes config-interfaces-order $linodeId $configId \ --ids 101 --ids 102 --ids 103 ``` [Learn more](https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli) - [Get a configuration profile interface](https://techdocs.akamai.com/linode-api/reference/get-linode-config-interface.md): Returns a single configuration profile interface. **Permissions and scopes** To call this operation, you need the following: - **Identity and access permissions**. Your user needs a role with these permissions assigned. [Learn more](https://techdocs.akamai.com/cloud-computing/docs/identity-access-cm-available-roles). - Permissions: `view_linode_config_profile_interface` - **OAuth scopes**. Your user needs these scopes assigned. [Learn more](https://techdocs.akamai.com/linode-api/reference/get-started#oauth). - Scopes: `linodes:read_only` **CLI** ```shell linode-cli linodes config-interface-view $linodeId $configId $interfaceId ``` [Learn more](https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli) - [Update a configuration profile interface](https://techdocs.akamai.com/linode-api/reference/put-linode-config-interface.md): Update a `vpc` or `public` configuration profile interface for a specific configuration profile, on a specific Linode. - A successful request triggers a `linode_config_update` [event](ref:get-events). - Only certain attributes can be updated for a configuration profile interface. You need to [add](ref:post-linode-config-interface) a new configuration profile interface on your Linode if you need new values for any other attribute. Here are the supported objects, based on the interface's `purpose`: - `public`. The `primary` attribute. - `vpc`. The `ip_ranges`, `ipv4`, or `primary` attributes. - You can't update a configuration profile with a `purpose` of `vlan`. **Permissions and scopes** To call this operation, you need the following: - **Identity and access permissions**. Your user needs a role with these permissions assigned. [Learn more](https://techdocs.akamai.com/cloud-computing/docs/identity-access-cm-available-roles). - Permissions: `update_linode_config_profile_interface` - **OAuth scopes**. Your user needs these scopes assigned. [Learn more](https://techdocs.akamai.com/linode-api/reference/get-started#oauth). - Scopes: `linodes:read_write` **CLI** ```shell linode-cli linodes config-interface-update $linodeId $configId $interfaceId \ --primary true \ --ipv4.vpc "10.0.1.2" \ --ipv4.nat_1_1 "203.0.113.2" ``` [Learn more](https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli) - [Delete a configuration profile interface](https://techdocs.akamai.com/linode-api/reference/delete-linode-config-interface.md): Deletes a configuration profile interface from a specific configuration profile, on a specific Linode. A successful request triggers a `linode_config_update` [event](ref:get-events). Consider these points before deleting a configuration profile interface: - You can't delete an active configuration profile interface. First, you need to shut down the associated Linode or restart it using another configuration profile. - You can't delete a configuration profile interface from a Linode that has a `cannot_delete_with_subresources` [resource lock](ref:post-resource-lock) set for it. **Permissions and scopes** To call this operation, you need the following: - **Identity and access permissions**. Your user needs a role with these permissions assigned. [Learn more](https://techdocs.akamai.com/cloud-computing/docs/identity-access-cm-available-roles). - Permissions: `delete_linode_config_profile_interface` - **OAuth scopes**. Your user needs these scopes assigned. [Learn more](https://techdocs.akamai.com/linode-api/reference/get-started#oauth). - Scopes: `linodes:read_write` **CLI** ```shell linode-cli linodes config-interface-delete $linodeId $configId $interfaceId ``` [Learn more](https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli) - [Create a disk](https://techdocs.akamai.com/linode-api/reference/post-add-linode-disk.md): Add a new disk to an existing Linode. You can create an empty disk to manually configure it later. You can also target a stored `image` to build the disk using a pre-configured file system--either through an image you've [created](ref:post-image) or via a StackScript. Consider these points when creating a new disk: **General** - A Linode can have up to 50 disks. - You need to provide at least one authentication mechanism for disk access: a `root_pass`, `authorized_keys`, or `authorized_users`, with the latter two offering SSH protection. **Empty disks** - To do this, don't include the `image`, `filesystem`, `stackscript_id`, or `stackscript_data` fields. - An empty disk still requires a `label`. - The default file system for an empty disk is `ext4`. **Disks created from an `image`** - A created disk inherits both the `label` and the `filesystem` from the target `image`, unless you specify otherwise. - We offer an example workflow to [create a disk using a stored image](ref:deploy-an-image). **Disks created from a StackScript** - You can run [List StackScripts](ref:get-stack-scripts) to review available StackScripts. - You need to include a StackScript-compatible `image` when creating the disk. Run [Get a StackScript](ref:get-stack-script) to review available images. **Permissions and scopes** To call this operation, you need the following: - **Identity and access permissions**. Your user needs a role with these permissions assigned. [Learn more](https://techdocs.akamai.com/cloud-computing/docs/identity-access-cm-available-roles). - Permissions: `create_linode_disk` - **OAuth scopes**. Your user needs these scopes assigned. [Learn more](https://techdocs.akamai.com/linode-api/reference/get-started#oauth). - Scopes: `linodes:read_write` **CLI** ```shell linode-cli linodes disk-create 123 \ --size 1300 \ --authorized_keys "ssh-rsa AAAA_valid_public_ssh_key_123456785== user@their-computer" \ --authorized_users "myUser" \ --authorized_users "secondaryUser" \ --root_pass aComplex@Password \ --image "linode/debian13" \ --stackscript_id 10079 \ --stackscript_data '{"gh_username": "linode"}' ``` [Learn more](https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli) - [List disks](https://techdocs.akamai.com/linode-api/reference/get-linode-disks.md): View information for disks associated with this Linode. **Permissions and scopes** To call this operation, you need the following: - **Identity and access permissions**. Your user needs a role with these permissions assigned. [Learn more](https://techdocs.akamai.com/cloud-computing/docs/identity-access-cm-available-roles). - Permissions: `view_linode_disk` - **OAuth scopes**. Your user needs these scopes assigned. [Learn more](https://techdocs.akamai.com/linode-api/reference/get-started#oauth). - Scopes: `linodes:read_only` **CLI** ```shell linode-cli linodes disks-list 123 ``` [Learn more](https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli) - [Get a disk](https://techdocs.akamai.com/linode-api/reference/get-linode-disk.md): View information for a specific disk assigned to a Linode. **Permissions and scopes** To call this operation, you need the following: - **Identity and access permissions**. Your user needs a role with these permissions assigned. [Learn more](https://techdocs.akamai.com/cloud-computing/docs/identity-access-cm-available-roles). - Permissions: `view_linode_disk` - **OAuth scopes**. Your user needs these scopes assigned. [Learn more](https://techdocs.akamai.com/linode-api/reference/get-started#oauth). - Scopes: `linodes:read_only` **CLI** ```shell linode-cli linodes disk-view 123 25674 ``` [Learn more](https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli) - [Update a disk](https://techdocs.akamai.com/linode-api/reference/put-disk.md): Update a specific disk on a Linode. **Permissions and scopes** To call this operation, you need the following: - **Identity and access permissions**. Your user needs a role with these permissions assigned. [Learn more](https://techdocs.akamai.com/cloud-computing/docs/identity-access-cm-available-roles). - Permissions: `update_linode_disk` - **OAuth scopes**. Your user needs these scopes assigned. [Learn more](https://techdocs.akamai.com/linode-api/reference/get-started#oauth). - Scopes: `linodes:read_write` **CLI** ```shell linode-cli linodes disk-update 123 25674 \ --label "Debian 13 Disk" ``` [Learn more](https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli) - [Delete a disk](https://techdocs.akamai.com/linode-api/reference/delete-disk.md): Delete a specific disk from a Linode. > 🚧 > > Deleting a disk is a destructive action and can't be undone. You can't delete a disk on a Linode that has a `cannot_delete_with_subresources` [resource lock](ref:post-resource-lock) set for it. **Permissions and scopes** To call this operation, you need the following: - **Identity and access permissions**. Your user needs a role with these permissions assigned. [Learn more](https://techdocs.akamai.com/cloud-computing/docs/identity-access-cm-available-roles). - Permissions: `delete_linode_disk` - **OAuth scopes**. Your user needs these scopes assigned. [Learn more](https://techdocs.akamai.com/linode-api/reference/get-started#oauth). - Scopes: `linodes:read_write` **CLI** ```shell linode-cli linodes disk-delete 123 24674 ``` [Learn more](https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli) - [Clone a disk](https://techdocs.akamai.com/linode-api/reference/post-clone-linode-disk.md): Copies a disk, byte-for-byte, into a new disk on the same Linode. The operation fails if the target doesn't have enough storage space. A Linode can have up to 50 disks. **Permissions and scopes** To call this operation, you need the following: - **Identity and access permissions**. Your user needs a role with these permissions assigned. [Learn more](https://techdocs.akamai.com/cloud-computing/docs/identity-access-cm-available-roles). - Permissions: `clone_linode_disk` - **OAuth scopes**. Your user needs these scopes assigned. [Learn more](https://techdocs.akamai.com/linode-api/reference/get-started#oauth). - Scopes: `linodes:read_write` **CLI** ```shell linode-cli linodes disk-clone ``` [Learn more](https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli) - [Reset a disk root password](https://techdocs.akamai.com/linode-api/reference/post-reset-disk-password.md): Resets the password of a disk. **Permissions and scopes** To call this operation, you need the following: - **Identity and access permissions**. Your user needs a role with these permissions assigned. [Learn more](https://techdocs.akamai.com/cloud-computing/docs/identity-access-cm-available-roles). - Permissions: `reset_linode_disk_root_password` - **OAuth scopes**. Your user needs these scopes assigned. [Learn more](https://techdocs.akamai.com/linode-api/reference/get-started#oauth). - Scopes: `linodes:read_write` **CLI** ```shell linode-cli linodes disk-reset-password \ 123 25674 \ --password aComplex@Password ``` [Learn more](https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli) - [Resize a disk](https://techdocs.akamai.com/linode-api/reference/post-resize-disk.md): Resizes a Disk. The Disk must not be in use. If the Disk is in use, the request will succeed but the resize will ultimately fail. For a request to succeed, the Linode must be shut down prior to resizing the Disk, or the Disk must not be assigned to the Linode's active Configuration Profile. If you are resizing the Disk to a smaller size, it cannot be made smaller than what is required by the total size of the files current on the Disk. **Permissions and scopes** To call this operation, you need the following: - **Identity and access permissions**. Your user needs a role with these permissions assigned. [Learn more](https://techdocs.akamai.com/cloud-computing/docs/identity-access-cm-available-roles). - Permissions: `resize_linode_disk` - **OAuth scopes**. Your user needs these scopes assigned. [Learn more](https://techdocs.akamai.com/linode-api/reference/get-started#oauth). - Scopes: `linodes:read_write` **CLI** ```shell linode-cli linodes disk-resize 123 25674 \ --size 2048 ``` [Learn more](https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli) - [List a Linode's firewalls](https://techdocs.akamai.com/linode-api/reference/get-linode-firewalls.md): View Firewall information for Firewalls assigned to this Linode. **Permissions and scopes** To call this operation, you need the following: - **Identity and access permissions**. Your user needs a role with these permissions assigned. [Learn more](https://techdocs.akamai.com/cloud-computing/docs/identity-access-cm-available-roles). - Permissions: `list_linode_firewalls` - **OAuth scopes**. Your user needs these scopes assigned. [Learn more](https://techdocs.akamai.com/linode-api/reference/get-started#oauth). - Scopes: `linodes:read_only` **CLI** ```shell linode-cli linodes firewalls-list 123 ``` [Learn more](https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli) - [Update a Linode's firewalls](https://techdocs.akamai.com/linode-api/reference/put-linode-firewalls.md): Replace the current list of assigned firewalls with a new list, or provide an empty list to remove all firewalls from this Linode. **Permissions and scopes** To call this operation, you need the following: - **Identity and access permissions**. Your user needs a role with these permissions assigned. [Learn more](https://techdocs.akamai.com/cloud-computing/docs/identity-access-cm-available-roles). - Permissions: `update_linode_firewalls` - **OAuth scopes**. Your user needs these scopes assigned. [Learn more](https://techdocs.akamai.com/linode-api/reference/get-started#oauth). - Scopes: `linodes:read_write` **CLI** ```shell linode-cli linodes firewalls-update 123 \ --firewall_ids '[1234]' ``` [Learn more](https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli) - [Apply a Linode's firewalls](https://techdocs.akamai.com/linode-api/reference/post-apply-firewalls.md): Reapply assigned firewalls to a Linode in case they were not applied successfully. The `firewall_apply` event indicates if the firewalls were applied. **Permissions and scopes** To call this operation, you need the following: - **Identity and access permissions**. Your user needs a role with these permissions assigned. [Learn more](https://techdocs.akamai.com/cloud-computing/docs/identity-access-cm-available-roles). - Permissions: `apply_linode_firewalls` - **OAuth scopes**. Your user needs these scopes assigned. [Learn more](https://techdocs.akamai.com/linode-api/reference/get-started#oauth). - Scopes: `linodes:read_write` **CLI** ```shell linode-cli linodes apply-firewalls 123 ``` [Learn more](https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli) - [Add a Linode interface](https://techdocs.akamai.com/linode-api/reference/post-linode-interface.md): Creates an interface for the Linode. This interface links to the Linode, rather than to a configuration profile. You can create, delete, or update interfaces when the Linode is either powered off or in the process of being created. Firewalls are applied to the Linode's VPC or public interface, rather than directly on the Linode. You can add, delete, or update these firewalls at any time. Firewalls are not applied to VLAN interfaces. A successful request triggers an `interface_create` [event](ref:get-events). You need to set one interface type: `vpc`, `public`, or `vlan`. Omit the others or set them to `null`. A Linode can have up to three interfaces: - Only one `public` interface is allowed on a Linode. - Multiple `vlan` interfaces are allowed, provided that they belong to distinct VLANs, which have unique `vlan_labels`. - One `vpc` interface is allowed. The Linode must be located in a region that supports Linode interfaces. Run [Get a region](ref:get-region) to see if interfaces are supported in that region. **Permissions and scopes** To call this operation, you need the following: - **Identity and access permissions**. Your user needs a role with these permissions assigned. [Learn more](https://techdocs.akamai.com/cloud-computing/docs/identity-access-cm-available-roles). - Permissions: `update_linode` - **OAuth scopes**. Your user needs these scopes assigned. [Learn more](https://techdocs.akamai.com/linode-api/reference/get-started#oauth). - Scopes: `linodes:read_write` **CLI** *Public interface* ```shell linode-cli linodes interface-add $linodeId \ --firewall_id 123 \ --default_route.ipv4 true \ --default_route.ipv6 true \ --public.ipv4.addresses '[{"address": "192.0.2.141", "primary": true}, {"address": "auto", "primary": false}]' \ --public.ipv6.ranges '[{"range": "2001:0db8::1/64"}, {"range": "/64"}]' ``` *VLAN interface* ```shell linode-cli linodes interface-add $linodeId \ --vlan.vlan_label my-vlan \ --vlan.ipam_address 192.168.2.2/24 ``` *VPC interface* ```shell linode-cli linodes interface-add $linodeId \ --firewall_id 123 \ --default_route.ipv4 true \ --vpc.subnet_id 321 \ --vpc.ipv4.addresses '[{"address": "10.0.0.1", "primary": true, "nat_1_1_address": "auto"}, {"address": "auto", "primary": false, "nat_1_1_address": null}]' \ --vpc.ipv4.ranges '[{"range": "/28"}, {"range": "10.11.12.0/24"}]' ``` [Learn more](https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli) - [List Linode interfaces](https://techdocs.akamai.com/linode-api/reference/get-linode-interfaces.md): This operation returns all interfaces assigned to a specific Linode. They list in the order they were created. On the Linode, interfaces also list in this order, and are typically named `eth0`, `eth1`, `eth2`, and so on. The MAC address is the most reliable method to identify an interface. The Linode needs to use `interfaces` and not configuration profile interfaces. Run [Get account settings](ref:get-account-settings) to see if Linode interfaces are supported. **Permissions and scopes** To call this operation, you need the following: - **Identity and access permissions**. Your user needs a role with these permissions assigned. [Learn more](https://techdocs.akamai.com/cloud-computing/docs/identity-access-cm-available-roles). - Permissions: `view_linode` - **OAuth scopes**. Your user needs these scopes assigned. [Learn more](https://techdocs.akamai.com/linode-api/reference/get-started#oauth). - Scopes: `linodes:read_write` **CLI** ```shell linode-cli linodes interfaces-list $linodeId ``` [Learn more](https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli) - [List a Linode's network interface history](https://techdocs.akamai.com/linode-api/reference/get-linode-interface-history.md): __Beta__ Lists the history of network interfaces by version for a Linode. This operation is for Linode interfaces, and not for legacy configuration profile interfaces. **Permissions and scopes** To call this operation, you need the following: - **OAuth scopes**. Your user needs these scopes assigned. [Learn more](https://techdocs.akamai.com/linode-api/reference/get-started#oauth). - Scopes: `linodes:read_only` **CLI** ```shell linode-cli linodes interface-history-list $linodeId ``` [Learn more](https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli) - [List Linode interface settings](https://techdocs.akamai.com/linode-api/reference/get-linode-interface-settings.md): Lists a Linode's interface settings, including Network Helper and default route settings. This operation is for Linode interfaces, not for legacy configuration profile interfaces. **Permissions and scopes** To call this operation, you need the following: - **Identity and access permissions**. Your user needs a role with these permissions assigned. [Learn more](https://techdocs.akamai.com/cloud-computing/docs/identity-access-cm-available-roles). - Permissions: `view_linode` - **OAuth scopes**. Your user needs these scopes assigned. [Learn more](https://techdocs.akamai.com/linode-api/reference/get-started#oauth). - Scopes: `linode:read_only` **CLI** ```shell linode-cli linodes interfaces-settings-list $linodeId ``` [Learn more](https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli) - [Update Linode interface settings](https://techdocs.akamai.com/linode-api/reference/put-linode-interface-settings.md): Updates Network Helper and default route settings on the Linode. Before enabling or disabling Network Helper, you need to power off the Linode. **Permissions and scopes** To call this operation, you need the following: - **Identity and access permissions**. Your user needs a role with these permissions assigned. [Learn more](https://techdocs.akamai.com/cloud-computing/docs/identity-access-cm-available-roles). - Permissions: `update_linode` - **OAuth scopes**. Your user needs these scopes assigned. [Learn more](https://techdocs.akamai.com/linode-api/reference/get-started#oauth). - Scopes: `linodes:read_write` **CLI** *Public interface* ```shell linode-cli linodes interface-settings-update $linodeId \ --network_helper true \ --default_route.ipv4_interface_id 4527 \ --default_route.ipv6_interface_id 4541 ``` *VLAN interface* ```shell linode-cli linodes interface-settings-update $linodeId \ --network_helper true ``` *VPC interface* ```shell linode-cli linodes interface-settings-update $linodeId \ --network_helper true \ --default_route.ipv4_interface_id 5527 ``` [Learn more](https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli) - [Get a Linode interface](https://techdocs.akamai.com/linode-api/reference/get-linode-interface.md): Returns an interface assigned to a specific Linode. **Permissions and scopes** To call this operation, you need the following: - **Identity and access permissions**. Your user needs a role with these permissions assigned. [Learn more](https://techdocs.akamai.com/cloud-computing/docs/identity-access-cm-available-roles). - Permissions: `view_linode` - **OAuth scopes**. Your user needs these scopes assigned. [Learn more](https://techdocs.akamai.com/linode-api/reference/get-started#oauth). - Scopes: `linodes:read_write` **CLI** ```shell linode-cli linodes interface-view $linodeId $interfaceId ``` [Learn more](https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli) - [Update a Linode interface](https://techdocs.akamai.com/linode-api/reference/put-linode-interface.md): Update the configuration of a Linode interface. **Permissions and scopes** To call this operation, you need the following: - **Identity and access permissions**. Your user needs a role with these permissions assigned. [Learn more](https://techdocs.akamai.com/cloud-computing/docs/identity-access-cm-available-roles). - Permissions: `update_linode` - **OAuth scopes**. Your user needs these scopes assigned. [Learn more](https://techdocs.akamai.com/linode-api/reference/get-started#oauth). - Scopes: `linodes:read_write` **CLI** *Public interface* ```shell linode-cli linodes interface-update $linodeId $interfaceId \ --default_route.ipv4 true \ --default_route.ipv6 false \ --public.ipv4.addresses '[{"address": "192.0.2.141", "primary": true}, {"address": "auto", "primary": false}]' \ --public.ipv6.ranges '[{"range": "2001:0db8"::1/64"}, {"range": "/64"}]' ``` *VLAN interface* ```shell linode-cli linodes interface-update $linodeId $interfaceId \ --vlan.vlan_label my-vlan \ --vlan.ipam_address 192.168.2.2/24 ``` *VPC interface* ```shell linode-cli linodes interface-update $linodeId $interfaceId \ --default_route.ipv4 true \ --vpc.subnet_id 321 \ --vpc.ipv4.addresses '[{"address": "10.0.0.1", "primary": true, "nat_1_1_address": "auto"}, {"address": "auto", "primary": false, "nat_1_1_address": null}]' \ --vpc.ipv4.ranges '[{"range": "/28"}, {"range": "10.11.12.0/24"}]' ``` [Learn more](https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli) - [Delete a Linode interface](https://techdocs.akamai.com/linode-api/reference/delete-linode-interface.md): Deletes a Linode interface on a specific Linode. Consider these points when deleting a Linode interface: - You can't delete an active interface. First, you need to shut down the associated Linode. - You can't delete a Linode interface from a Linode that has a `cannot_delete_with_subresources` [resource lock](ref:post-resource-lock) set for it. **Permissions and scopes** To call this operation, you need the following: - **Identity and access permissions**. Your user needs a role with these permissions assigned. [Learn more](https://techdocs.akamai.com/cloud-computing/docs/identity-access-cm-available-roles). - Permissions: `update_linode` - **OAuth scopes**. Your user needs these scopes assigned. [Learn more](https://techdocs.akamai.com/linode-api/reference/get-started#oauth). - Scopes: `linodes:read_write` **CLI** ```shell linode-cli linodes interface-delete $linodeId $interfaceId ``` [Learn more](https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli) - [List Linode interface firewalls](https://techdocs.akamai.com/linode-api/reference/get-linode-interface-firewalls.md): Lists firewalls assigned to an interface. **Permissions and scopes** To call this operation, you need the following: - **Identity and access permissions**. Your user needs a role with these permissions assigned. [Learn more](https://techdocs.akamai.com/cloud-computing/docs/identity-access-cm-available-roles). - Permissions: `view_linode` - **OAuth scopes**. Your user needs these scopes assigned. [Learn more](https://techdocs.akamai.com/linode-api/reference/get-started#oauth). - Scopes: `nodebalancers:read_only` **CLI** ```shell linode-cli linodes interface-firewalls-list $linodeId $interfaceId ``` [Learn more](https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli) - [Upgrade to Linode interfaces](https://techdocs.akamai.com/linode-api/reference/post-upgrade-linode-interfaces.md): Automatically upgrades all legacy config interfaces of a single configuration profile to Linode interfaces. A Linode interface is directly associated with the Linode, rather than being tied to a configuration profile. Firewalls are applied to the Linode interface, not directly to the Linode itself. > ❗️ This upgrade is irreversible > > Once you upgrade a Linode to use Linode interfaces, you can't use legacy config interfaces. This means you can no longer use the Linode with any Linode products that require private IPs, such as NodeBalancer. You can use `dry_run` to preview the upgrade. Before upgrading interfaces, you can check the new Linode interface configuration by performing a dry run, where you set `dry_run` to `true` or omit it. A `dry_run` runs the upgrade logic and returns a JSON representation of what the interface configuration will be after the upgrade without committing any changes. When you run this operation with `dry_run` set to `false`, the following occurs: - It creates matching interfaces on the Linode based on the interfaces present on the `config_id`. - All firewalls are removed from the Linode. Any firewalls that were originally attached to the Linode are now applied to the public and VPC interfaces. Firewalls are not applied to VLAN interfaces. If the Linode has no firewalls attached, then default firewalls are not used. - If no legacy config interfaces are defined (`legacy_config`) in the `config_id`, a public interface is created using the public IPv4 assigned to the Linode. The same is the case if the Linode has no config defined. - For public interfaces, the Linode's current MAC address and SLAAC address are conserved. The MAC address won't change. - It deletes all legacy config interfaces from all configs. - It returns the list of interfaces for the Linode. Requirements: - The `config_id` for the legacy config interfaces can't use a public interface private IPv4 address. - The Linode needs a MAC address in the database if it's IPv6 enabled. If it doesn't, an error message tells you what to do. - The Linode must be in a region that supports Linode interfaces. Run [Get a region](ref:get-region). - Your account must allow creation of Linodes with Linode interfaces, run [Get account settings](ref:get-account-settings). - If the Linode has a user with a non-standard username, it can't be upgraded. **Permissions and scopes** To call this operation, you need the following: - **OAuth scopes**. Your user needs these scopes assigned. [Learn more](https://techdocs.akamai.com/linode-api/reference/get-started#oauth). - Scopes: `linodes:read_write` **CLI** ```shell linode-cli linodes interfaces-upgrade $linodeId ``` [Learn more](https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli) - [Allocate an IPv4 address](https://techdocs.akamai.com/linode-api/reference/post-add-linode-ip.md): Allocates a public or private IPv4 address to a Linode. Public IP Addresses, after the one included with each Linode, incur an additional monthly charge. If you need an additional public IP Address you must request one - please [Open a support ticket](ref:post-ticket). You may not add more than one private IPv4 address to a single Linode. **Permissions and scopes** To call this operation, you need the following: - **Identity and access permissions**. Your user needs a role with these permissions assigned. [Learn more](https://techdocs.akamai.com/cloud-computing/docs/identity-access-cm-available-roles). - Permissions: `view_linode` - **OAuth scopes**. Your user needs these scopes assigned. [Learn more](https://techdocs.akamai.com/linode-api/reference/get-started#oauth). - Scopes: `linodes:read_write` **CLI** ```shell linode-cli linodes ip-add 123 \ --address 192.0.2.141 \ --type ipv4 \ --public true ``` [Learn more](https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli) - [Get networking information](https://techdocs.akamai.com/linode-api/reference/get-linode-ips.md): Returns networking information for a single Linode. > 📘 > > If the target Linode has several configuration profiles that include a Virtual Private Cloud (VPC) interface, the response lists address information for all of the VPCs. **Permissions and scopes** To call this operation, you need the following: - **Identity and access permissions**. Your user needs a role with these permissions assigned. [Learn more](https://techdocs.akamai.com/cloud-computing/docs/identity-access-cm-available-roles). - Permissions: `view_linode` - **OAuth scopes**. Your user needs these scopes assigned. [Learn more](https://techdocs.akamai.com/linode-api/reference/get-started#oauth). - Scopes: `linodes:read_only` **CLI** ```shell linode-cli linodes ips-list 123 ``` [Learn more](https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli) - [Get a Linode's IP address](https://techdocs.akamai.com/linode-api/reference/get-linode-ip.md): View information for a Linode's set of IPs, its Linode interfaces, and VPC IPs and ranges. **Permissions and scopes** To call this operation, you need the following: - **Identity and access permissions**. Your user needs a role with these permissions assigned. [Learn more](https://techdocs.akamai.com/cloud-computing/docs/identity-access-cm-available-roles). - Permissions: `view_linode` - **OAuth scopes**. Your user needs these scopes assigned. [Learn more](https://techdocs.akamai.com/linode-api/reference/get-started#oauth). - Scopes: `linodes:read_only` **CLI** ```shell linode-cli linodes ip-view 123456 192.0.2.164 ``` [Learn more](https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli) - [Update an IP address's RDNS for a Linode](https://techdocs.akamai.com/linode-api/reference/put-linode-ip.md): Updates the reverse DNS (RDNS) for a Linode's IP Address. This may be done for both IPv4 and IPv6 addresses. Setting the RDNS to `null` for a public IPv4 address, resets it to the default `ip.linodeusercontent.com` RDNS value. **Permissions and scopes** To call this operation, you need the following: - **Identity and access permissions**. Your user needs a role with these permissions assigned. [Learn more](https://techdocs.akamai.com/cloud-computing/docs/identity-access-cm-available-roles). - Permissions: `update_linode` - **OAuth scopes**. Your user needs these scopes assigned. [Learn more](https://techdocs.akamai.com/linode-api/reference/get-started#oauth). - Scopes: `linodes:read_write` **CLI** ```shell linode-cli linodes ip-update 123 \ 203.0.113.1 \ --rdns test.example.org ``` [Learn more](https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli) - [Delete an IPv4 address](https://techdocs.akamai.com/linode-api/reference/delete-linode-ip.md): Deletes a public or private IPv4 address assigned to this Linode. Consider these points before deleting an IPv4 address: - A delete will fail if the target address is the Linode's last remaining public IPv4 address, or if the address has a 1:1 NAT with an active VPC subnet address. - You can't use this operation to delete an IPv4 address assigned to a Linode interface. Run the [update the Linode interface](ref:put-linode-interface) operation instead. - You can't delete an IPv4 address from a Linode that has a `cannot_delete_with_subresources` [resource lock](ref:post-resource-lock) set for it. **Permissions and scopes** To call this operation, you need the following: - **Identity and access permissions**. Your user needs a role with these permissions assigned. [Learn more](https://techdocs.akamai.com/cloud-computing/docs/identity-access-cm-available-roles). - Permissions: `update_linode` - **OAuth scopes**. Your user needs these scopes assigned. [Learn more](https://techdocs.akamai.com/linode-api/reference/get-started#oauth). - Scopes: `linodes:read_write` **CLI** ```shell linode-cli linodes ip-delete 97.107.143.141 ``` [Learn more](https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli) - [Get daily Linode statistics](https://techdocs.akamai.com/linode-api/reference/get-linode-stats.md): Returns CPU, IO, IPv4, and IPv6 statistics for your Linode for the past 24 hours. **Permissions and scopes** To call this operation, you need the following: - **Identity and access permissions**. Your user needs a role with these permissions assigned. [Learn more](https://techdocs.akamai.com/cloud-computing/docs/identity-access-cm-available-roles). - Permissions: `view_linode_stats` - **OAuth scopes**. Your user needs these scopes assigned. [Learn more](https://techdocs.akamai.com/linode-api/reference/get-started#oauth). - Scopes: `linodes:read_only` - [Get a month's Linode statistics](https://techdocs.akamai.com/linode-api/reference/get-linode-stats-by-year-month.md): Returns CPU, IO, IPv4, and IPv6 statistics for your Linode for a specific month. If the `{year}` and `{month}` are set to the current month, the API returns statistics for the past 30 days. **Permissions and scopes** To call this operation, you need the following: - **Identity and access permissions**. Your user needs a role with these permissions assigned. [Learn more](https://techdocs.akamai.com/cloud-computing/docs/identity-access-cm-available-roles). - Permissions: `view_linode_monthly_stats` - **OAuth scopes**. Your user needs these scopes assigned. [Learn more](https://techdocs.akamai.com/linode-api/reference/get-started#oauth). - Scopes: `linodes:read_only` - [Get this month's network transfer stats](https://techdocs.akamai.com/linode-api/reference/get-linode-transfer.md): Returns a Linode's network transfer pool statistics for the current month. **Permissions and scopes** To call this operation, you need the following: - **Identity and access permissions**. Your user needs a role with these permissions assigned. [Learn more](https://techdocs.akamai.com/cloud-computing/docs/identity-access-cm-available-roles). - Permissions: `view_linode_monthly_network_transfer_stats` - **OAuth scopes**. Your user needs these scopes assigned. [Learn more](https://techdocs.akamai.com/linode-api/reference/get-started#oauth). - Scopes: `linodes:read_only` **CLI** ```shell linode-cli linodes transfer-view 123 ``` [Learn more](https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli) - [Get monthly network transfer stats](https://techdocs.akamai.com/linode-api/reference/get-linode-transfer-by-year-month.md): Returns a Linode's network transfer pool statistics for a specific month. If the `{year}` and `{month}` are set to the current month, the API returns statistics for the past 30 days. **Permissions and scopes** To call this operation, you need the following: - **OAuth scopes**. Your user needs these scopes assigned. [Learn more](https://techdocs.akamai.com/linode-api/reference/get-started#oauth). - Scopes: `linodes:read_only` - [List kernels](https://techdocs.akamai.com/linode-api/reference/get-kernels.md): Lists available kernels on your Linodes. > 👍 > > With the extensive list of available kernels, keep [pagination](ref:pagination) controls in mind when managing responses to this operation. **Permissions and scopes** To call this operation, you need the following: - **Identity and access permissions**. This operation is internet-facing. No permissions are required. **CLI** ```shell linode-cli kernels list ``` [Learn more](https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli) - [Get a kernel](https://techdocs.akamai.com/linode-api/reference/get-kernel.md): Returns information about a single kernel on a Linode. **Permissions and scopes** To call this operation, you need the following: - **Identity and access permissions**. This operation is internet-facing. No permissions are required. **CLI** ```shell linode-cli kernels view latest-64bit ``` [Learn more](https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli) - [Create a Kubernetes cluster](https://techdocs.akamai.com/linode-api/reference/post-lke-cluster.md): Creates a Kubernetes cluster. The Kubernetes cluster will be created asynchronously. You can use the events system to determine when the Kubernetes cluster is ready to use. Please note that it often takes 2-5 minutes before the [Kubernetes API endpoints](ref:get-lke-cluster-api-endpoints) and the [Kubeconfig file](ref:get-lke-cluster-kubeconfig) for the new cluster are ready. **Permissions and scopes** To call this operation, you need the following: - **Identity and access permissions**. Your user needs these roles assigned. [Learn more](https://techdocs.akamai.com/cloud-computing/docs/identity-access-cm-available-roles). - Roles: `account_lkecluster_creator` - **OAuth scopes**. Your user needs these scopes assigned. [Learn more](https://techdocs.akamai.com/linode-api/reference/get-started#oauth). - Scopes: `lke:read_write` **CLI** ```shell linode-cli lke cluster-create \ --label cluster12345 \ --region us-central \ --k8s_version 1.33 \ --apl_enabled false \ --control_plane.high_availability true \ --node_pools.type g6-standard-4 --node_pools.count 6 \ --node_pools.type g6-standard-8 --node_pools.count 3 \ --node_pools.autoscaler.enabled true \ --node_pools.autoscaler.max 12 \ --node_pools.autoscaler.min 3 \ --tags ecomm ``` [Learn more](https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli) - [List Kubernetes clusters](https://techdocs.akamai.com/linode-api/reference/get-lke-clusters.md): Lists current Kubernetes clusters available on your account. **Permissions and scopes** To call this operation, you need the following: - **Identity and access permissions**. Your user needs these roles assigned. [Learn more](https://techdocs.akamai.com/cloud-computing/docs/identity-access-cm-available-roles). - Roles: `lkecluster_viewer` - **OAuth scopes**. Your user needs these scopes assigned. [Learn more](https://techdocs.akamai.com/linode-api/reference/get-started#oauth). - Scopes: `lke:read_only` **CLI** ```shell linode-cli lke clusters-list ``` [Learn more](https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli) - [Get a Kubernetes cluster](https://techdocs.akamai.com/linode-api/reference/get-lke-cluster.md): Get a specific Cluster by ID. **Permissions and scopes** To call this operation, you need the following: - **Identity and access permissions**. Your user needs these roles assigned. [Learn more](https://techdocs.akamai.com/cloud-computing/docs/identity-access-cm-available-roles). - Roles: `lkecluster_viewer` - **OAuth scopes**. Your user needs these scopes assigned. [Learn more](https://techdocs.akamai.com/linode-api/reference/get-started#oauth). - Scopes: `lke:read_only` **CLI** ```shell linode-cli lke cluster-view 12345 ``` [Learn more](https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli) - [Update a Kubernetes cluster](https://techdocs.akamai.com/linode-api/reference/put-lke-cluster.md): Updates a Kubernetes cluster. **Permissions and scopes** To call this operation, you need the following: - **Identity and access permissions**. Your user needs these roles assigned. [Learn more](https://techdocs.akamai.com/cloud-computing/docs/identity-access-cm-available-roles). - Roles: `lkecluster_admin` - **OAuth scopes**. Your user needs these scopes assigned. [Learn more](https://techdocs.akamai.com/linode-api/reference/get-started#oauth). - Scopes: `lke:read_write` **CLI** ```shell linode-cli lke cluster-update 12345 \ --label lkecluster54321 \ --control_plane.high_availability true \ --k8s_version 1.33 \ --tags ecomm \ --tags blog \ --tags prod \ --tags monitoring ``` [Learn more](https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli) - [Delete a Kubernetes cluster](https://techdocs.akamai.com/linode-api/reference/delete-lke-cluster.md): Deletes a cluster from your account. > 🚧 > > Deleting a cluster is a destructive action and can't be undone. When a cluster is deleted, all supporting Kubernetes services are removed from your account along with all Linodes in your cluster's node pools. You must have `read_write` permission to the cluster to initiate deletion. Some additional services associated with your cluster remain active on your account. These services include NodeBalancers and Block Storage volumes. To avoid further charges, delete these services manually through Cloud Manager, the Linode CLI, or the Linode API. Account administrators can configure a resource lock with the [Create a resource lock](ref:post-resource-lock) operation to prevent a cluster from being deleted. They can also remove the lock with the [Delete a resource lock](ref:delete-resource-lock) operation. **Permissions and scopes** To call this operation, you need the following: - **Identity and access permissions**. Your user needs these roles assigned. [Learn more](https://techdocs.akamai.com/cloud-computing/docs/identity-access-cm-available-roles). - Roles: `lkecluster_admin` - **OAuth scopes**. Your user needs these scopes assigned. [Learn more](https://techdocs.akamai.com/linode-api/reference/get-started#oauth). - Scopes: `lke:read_write` **CLI** ```shell linode-cli lke cluster-delete 12345 ``` [Learn more](https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli) - [Recycle cluster nodes](https://techdocs.akamai.com/linode-api/reference/post-lke-cluster-recycle.md): Recycles all nodes in all pools of a designated Kubernetes Cluster. All Linodes within the Cluster will be deleted and replaced with new Linodes on a rolling basis, which may take several minutes. Replacement Nodes are installed with the latest available patch version for the Cluster's current Kubernetes minor release. __Any local storage on deleted Linodes (such as `hostPath` and `emptyDir` volumes, or `local` PersistentVolumes) will be erased.__ **Permissions and scopes** To call this operation, you need the following: - **OAuth scopes**. Your user needs these scopes assigned. [Learn more](https://techdocs.akamai.com/linode-api/reference/get-started#oauth). - Scopes: `lke:read_write` **CLI** ```shell linode-cli lke cluster-nodes-recycle 12345 ``` [Learn more](https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli) - [Regenerate a Kubernetes cluster](https://techdocs.akamai.com/linode-api/reference/post-lke-cluster-regenerate.md): Regenerate the Kubeconfig file and/or the service account token for a Cluster. This is a helper operation that allows performing both the [Delete a Kubeconfig](ref:delete-lke-cluster-kubeconfig) and the [Delete a service token](ref:delete-lke-service-token) operations with a single request. When using this operation, at least one of `kubeconfig` or `servicetoken` is required. > 📘 > > When regenerating a service account token, the cluster's control plane components and Linode CSI drivers are also restarted and configured with the new token. High availability clusters shouldn't experience any disruption, while standard clusters may experience brief control plane downtime while components are restarted. **Permissions and scopes** To call this operation, you need the following: - **Identity and access permissions**. Your user needs these roles assigned. [Learn more](https://techdocs.akamai.com/cloud-computing/docs/identity-access-cm-available-roles). - Roles: `lkecluster_admin` - **OAuth scopes**. Your user needs these scopes assigned. [Learn more](https://techdocs.akamai.com/linode-api/reference/get-started#oauth). - Scopes: `lke:read_write` **CLI** ```shell linode-cli lke regenerate 12345 \ --kubeconfig true \ --servicetoken true ``` [Learn more](https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli) - [Get the control plane access control list](https://techdocs.akamai.com/linode-api/reference/get-lke-cluster-acl.md): Get a specific cluster's control plane access control List. **Permissions and scopes** To call this operation, you need the following: - **Identity and access permissions**. Your user needs these roles assigned. [Learn more](https://techdocs.akamai.com/cloud-computing/docs/identity-access-cm-available-roles). - Roles: `lkecluster_viewer` - **OAuth scopes**. Your user needs these scopes assigned. [Learn more](https://techdocs.akamai.com/linode-api/reference/get-started#oauth). - Scopes: `lke:read_only` **CLI** ```shell linode-cli lke cluster-acl-view 12345 ``` [Learn more](https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli) - [Update the control plane access control list](https://techdocs.akamai.com/linode-api/reference/put-lke-cluster-acl.md): Updates a specific cluster's control plane access control list. **Permissions and scopes** To call this operation, you need the following: - **Identity and access permissions**. Your user needs these roles assigned. [Learn more](https://techdocs.akamai.com/cloud-computing/docs/identity-access-cm-available-roles). - Roles: `lkecluster_admin` - **OAuth scopes**. Your user needs these scopes assigned. [Learn more](https://techdocs.akamai.com/linode-api/reference/get-started#oauth). - Scopes: `lke:read_write` **CLI** ```shell linode-cli lke cluster-acl-update 12345 \ --acl.enabled true \ --acl.addresses.ipv4 "203.0.113.1" \ --acl.addresses.ipv6 "2001:db8:1234:abcd::/64" ``` [Learn more](https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli) - [Delete the control plane access control list](https://techdocs.akamai.com/linode-api/reference/delete-lke-cluster-acl.md): Disables control plane access controls and deletes all rules. It has the same effect as calling `PUT` with an ACL JSON map value of `{"enabled": false}`. **Permissions and scopes** To call this operation, you need the following: - **Identity and access permissions**. Your user needs these roles assigned. [Learn more](https://techdocs.akamai.com/cloud-computing/docs/identity-access-cm-available-roles). - Roles: `lkecluster_admin` - **OAuth scopes**. Your user needs these scopes assigned. [Learn more](https://techdocs.akamai.com/linode-api/reference/get-started#oauth). - Scopes: `lke:read_write` **CLI** ```shell linode-cli lke cluster-acl-delete 12345 ``` [Learn more](https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli) - [Get a Kubernetes cluster dashboard URL](https://techdocs.akamai.com/linode-api/reference/get-lke-cluster-dashboard.md): Get a [Kubernetes Dashboard](https://github.com/kubernetes/dashboard) access URL for this Cluster, which enables performance of administrative tasks through a web interface. Dashboards are installed for Clusters by default. To access the Cluster Dashboard login prompt, enter the URL in a web browser. Select either __Token__ or __Kubeconfig__ authentication, then select __Sign in__. For additional guidance on using the Cluster Dashboard, see the [Navigating the Cluster Dashboard](https://www.linode.com/docs/guides/using-the-kubernetes-dashboard-on-lke/#navigating-the-cluster-dashboard) section of our guide on [Using the Kubernetes Dashboard on LKE](https://www.linode.com/docs/guides/using-the-kubernetes-dashboard-on-lke/). **Permissions and scopes** To call this operation, you need the following: - **Identity and access permissions**. Your user needs these roles assigned. [Learn more](https://techdocs.akamai.com/cloud-computing/docs/identity-access-cm-available-roles). - Roles: `lkecluster_viewer` - **OAuth scopes**. Your user needs these scopes assigned. [Learn more](https://techdocs.akamai.com/linode-api/reference/get-started#oauth). - Scopes: `lke:read_only` **CLI** ```shell linode-cli lke cluster-dashboard-url 12345 ``` [Learn more](https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli) - [Get a Kubeconfig](https://techdocs.akamai.com/linode-api/reference/get-lke-cluster-kubeconfig.md): Get the Kubeconfig file for a Cluster. Please note that it often takes 2-5 minutes before the Kubeconfig file is ready after first [creating a new cluster](ref:post-lke-cluster). **Permissions and scopes** To call this operation, you need the following: - **Identity and access permissions**. Your user needs these roles assigned. [Learn more](https://techdocs.akamai.com/cloud-computing/docs/identity-access-cm-available-roles). - Roles: `lkecluster_admin` - **OAuth scopes**. Your user needs these scopes assigned. [Learn more](https://techdocs.akamai.com/linode-api/reference/get-started#oauth). - Scopes: `lke:read_write` **CLI** ```shell linode-cli lke kubeconfig-view 12345 ``` [Learn more](https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli) - [Delete a Kubeconfig](https://techdocs.akamai.com/linode-api/reference/delete-lke-cluster-kubeconfig.md): Delete and regenerate the Kubeconfig file for a Cluster. **Permissions and scopes** To call this operation, you need the following: - **Identity and access permissions**. Your user needs these roles assigned. [Learn more](https://techdocs.akamai.com/cloud-computing/docs/identity-access-cm-available-roles). - Roles: `lkecluster_admin` - **OAuth scopes**. Your user needs these scopes assigned. [Learn more](https://techdocs.akamai.com/linode-api/reference/get-started#oauth). - Scopes: `lke:read_write` **CLI** ```shell linode-cli lke kubeconfig-delete 12345 ``` [Learn more](https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli) - [Get a node](https://techdocs.akamai.com/linode-api/reference/get-lke-cluster-node.md): Returns the values for a specified node object. **Permissions and scopes** To call this operation, you need the following: - **Identity and access permissions**. Your user needs these roles assigned. [Learn more](https://techdocs.akamai.com/cloud-computing/docs/identity-access-cm-available-roles). - Roles: `lkecluster_viewer` - **OAuth scopes**. Your user needs these scopes assigned. [Learn more](https://techdocs.akamai.com/linode-api/reference/get-started#oauth). - Scopes: `lke:read_write` **CLI** ```shell linode-cli lke node-view 123456 12345-6aa78910bc ``` [Learn more](https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli) - [Delete a node](https://techdocs.akamai.com/linode-api/reference/delete-lke-cluster-node.md): Deletes a specific node from a node pool. __Deleting a Node is a destructive action and cannot be undone.__ Deleting a node reduces the size of the node pool it belongs to. **Permissions and scopes** To call this operation, you need the following: - **Identity and access permissions**. Your user needs these roles assigned. [Learn more](https://techdocs.akamai.com/cloud-computing/docs/identity-access-cm-available-roles). - Roles: `lkecluster_admin` - **OAuth scopes**. Your user needs these scopes assigned. [Learn more](https://techdocs.akamai.com/linode-api/reference/get-started#oauth). - Scopes: `lke:read_write` **CLI** ```shell linode-cli lke node-delete 12345 12345-6aa78910bc ``` [Learn more](https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli) - [Recycle a node](https://techdocs.akamai.com/linode-api/reference/post-lke-cluster-node-recycle.md): Recycles an individual Node in the designated Kubernetes Cluster. The Node will be deleted and replaced with a new Linode, which may take a few minutes. Replacement Nodes are installed with the latest available patch for the Cluster's Kubernetes Version. __Any local storage on deleted Linodes (such as `hostPath` and `emptyDir` volumes, or `local` PersistentVolumes) will be erased.__ **Permissions and scopes** To call this operation, you need the following: - **Identity and access permissions**. Your user needs these roles assigned. [Learn more](https://techdocs.akamai.com/cloud-computing/docs/identity-access-cm-available-roles). - Roles: `lkecluster_admin` - **OAuth scopes**. Your user needs these scopes assigned. [Learn more](https://techdocs.akamai.com/linode-api/reference/get-started#oauth). - Scopes: `lke:read_write` **CLI** ```shell linode-cli lke node-recycle 12345 12345-6aa78910bc ``` [Learn more](https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli) - [Create a node pool](https://techdocs.akamai.com/linode-api/reference/post-lke-cluster-pools.md): Creates a new node pool for the designated Kubernetes cluster. **Permissions and scopes** To call this operation, you need the following: - **Identity and access permissions**. Your user needs these roles assigned. [Learn more](https://techdocs.akamai.com/cloud-computing/docs/identity-access-cm-available-roles). - Roles: `lkecluster_admin` - **OAuth scopes**. Your user needs these scopes assigned. [Learn more](https://techdocs.akamai.com/linode-api/reference/get-started#oauth). - Scopes: `lke:read_write` **CLI** ```shell linode-cli lke pool-create 12345 \ --type g6-standard-4 \ --count 6 \ --tags example-tag \ --autoscaler.enabled true \ --autoscaler.max 12 \ --autoscaler.min 3 \ --labels '{ "example.com/my-app":"team1" }' \ --taints.effect "NoSchedule" \ --taints.key "example.com/my-app" \ --taints.value "teamA" ``` [Learn more](https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli) - [List node pools](https://techdocs.akamai.com/linode-api/reference/get-lke-cluster-pools.md): Returns all active node pools on a Kubernetes cluster. **Permissions and scopes** To call this operation, you need the following: - **Identity and access permissions**. Your user needs these roles assigned. [Learn more](https://techdocs.akamai.com/cloud-computing/docs/identity-access-cm-available-roles). - Roles: `lkecluster_viewer` - **OAuth scopes**. Your user needs these scopes assigned. [Learn more](https://techdocs.akamai.com/linode-api/reference/get-started#oauth). - Scopes: `lke:read_only` **CLI** ```shell linode-cli lke pools-list 12345 ``` [Learn more](https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli) - [Get a node pool](https://techdocs.akamai.com/linode-api/reference/get-lke-node-pool.md): Get a specific node pool. **Permissions and scopes** To call this operation, you need the following: - **Identity and access permissions**. Your user needs these roles assigned. [Learn more](https://techdocs.akamai.com/cloud-computing/docs/identity-access-cm-available-roles). - Roles: `lkecluster_viewer` - **OAuth scopes**. Your user needs these scopes assigned. [Learn more](https://techdocs.akamai.com/linode-api/reference/get-started#oauth). - Scopes: `lke:read_only` **CLI** ```shell linode-cli lke pool-view 12345 456 ``` [Learn more](https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli) - [Update a node pool](https://techdocs.akamai.com/linode-api/reference/put-lke-node-pool.md): Updates a node pool's count, labels, taints, and autoscaler configuration. Linodes are created or deleted to match changes to the node pool's count. Specifying labels or taints on update overwrites any previous values, and updates existing nodes with the new values without a recycle. __Any local storage on deleted Linodes (such as `hostPath` and `emptyDir` volumes, or `local` PersistentVolumes) will be erased.__ **Permissions and scopes** To call this operation, you need the following: - **Identity and access permissions**. Your user needs these roles assigned. [Learn more](https://techdocs.akamai.com/cloud-computing/docs/identity-access-cm-available-roles). - Roles: `lkecluster_admin` - **OAuth scopes**. Your user needs these scopes assigned. [Learn more](https://techdocs.akamai.com/linode-api/reference/get-started#oauth). - Scopes: `lke:read_write` **CLI** ```shell linode-cli lke pool-update 12345 456 \ --count 6 \ --autoscaler.enabled true \ --autoscaler.max 12 \ --autoscaler.min 3 \ --labels '{ "example.com/my-app":"team1", "env":"staging" }' \ --taints.effect "NoSchedule" \ --taints.key "example.com/my-app" \ --taints.value "teamA" ``` [Learn more](https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli) - [Delete a node pool](https://techdocs.akamai.com/linode-api/reference/delete-lke-node-pool.md): Delete a specific node pool from a Kubernetes cluster. __Deleting a node pool is a destructive action and can't be undone.__ Deleting a node pool deletes all Linodes within that pool. Account administrators can configure a resource lock with the [Create a resource lock](ref:post-resource-lock) operation to prevent a node pool from being deleted. They can also remove the lock with the [Delete a resource lock](ref:delete-resource-lock) operation. **Permissions and scopes** To call this operation, you need the following: - **Identity and access permissions**. Your user needs these roles assigned. [Learn more](https://techdocs.akamai.com/cloud-computing/docs/identity-access-cm-available-roles). - Roles: `lkecluster_admin` - **OAuth scopes**. Your user needs these scopes assigned. [Learn more](https://techdocs.akamai.com/linode-api/reference/get-started#oauth). - Scopes: `lke:read_write` **CLI** ```shell linode-cli lke pool-delete 12345 456 ``` [Learn more](https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli) - [Recycle a node pool](https://techdocs.akamai.com/linode-api/reference/post-lke-cluster-pool-recycle.md): Recycles a node pool for the designated Kubernetes cluster. All Linodes within the node pool will be deleted and replaced with new Linodes on a rolling basis, which may take several minutes. Replacement nodes are installed with the latest available patch for the cluster's Kubernetes version. __Any local storage on deleted Linodes (such as `hostPath` and `emptyDir` volumes, or `local` PersistentVolumes) will be erased.__ **Permissions and scopes** To call this operation, you need the following: - **Identity and access permissions**. Your user needs these roles assigned. [Learn more](https://techdocs.akamai.com/cloud-computing/docs/identity-access-cm-available-roles). - Roles: `lkecluster_admin` - **OAuth scopes**. Your user needs these scopes assigned. [Learn more](https://techdocs.akamai.com/linode-api/reference/get-started#oauth). - Scopes: `lke:read_write` **CLI** ```shell linode-cli lke pool-recycle 12345 456 ``` [Learn more](https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli) - [Delete a service token](https://techdocs.akamai.com/linode-api/reference/delete-lke-service-token.md): Delete and regenerate the service account token for a Cluster. > 📘 > > When you regenerate a service account token, the cluster's control plane components and Linode CSI drivers are also restarted and configured with the new token. High availability clusters shouldn't experience any disruption, while standard clusters may experience brief control plane downtime while components are restarted. **Permissions and scopes** To call this operation, you need the following: - **Identity and access permissions**. Your user needs these roles assigned. [Learn more](https://techdocs.akamai.com/cloud-computing/docs/identity-access-cm-available-roles). - Roles: `lkecluster_admin` - **OAuth scopes**. Your user needs these scopes assigned. [Learn more](https://techdocs.akamai.com/linode-api/reference/get-started#oauth). - Scopes: `lke:read_write` **CLI** ```shell linode-cli lke service-token-delete 12345 ``` [Learn more](https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli) - [List LKE Kubernetes versions (any tier)](https://techdocs.akamai.com/linode-api/reference/get-lke-tiers-versions.md): List LKE Kubernetes versions available for deployment to a Kubernetes cluster (any tier). **Permissions and scopes** To call this operation, you need the following: - **Identity and access permissions**. Your user needs these roles assigned. [Learn more](https://techdocs.akamai.com/cloud-computing/docs/identity-access-cm-available-roles). - Roles: `lkecluster_viewer` - **OAuth scopes**. Your user needs these scopes assigned. [Learn more](https://techdocs.akamai.com/linode-api/reference/get-started#oauth). - Scopes: `lke:read_only` **CLI** ```shell linode-cli lke tiered-versions-list standard ``` [Learn more](https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli) - [Get an LKE Kubernetes version (any tier)](https://techdocs.akamai.com/linode-api/reference/get-lke-tiers-version.md): View an LKE Kubernetes version available for deployment to a Kubernetes cluster (any tier) **Permissions and scopes** To call this operation, you need the following: - **Identity and access permissions**. Your user needs these roles assigned. [Learn more](https://techdocs.akamai.com/cloud-computing/docs/identity-access-cm-available-roles). - Roles: `lkecluster_viewer` - **OAuth scopes**. Your user needs these scopes assigned. [Learn more](https://techdocs.akamai.com/linode-api/reference/get-started#oauth). - Scopes: `lke:read_only` **CLI** ```shell linode-cli lke tiered-version-view standard 1.31 ``` [Learn more](https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli) - [List LKE Kubernetes versions (non-enterprise)](https://techdocs.akamai.com/linode-api/reference/get-lke-versions.md): List LKE Kubernetes versions available for deployment to a standard-tier Kubernetes cluster. **Permissions and scopes** To call this operation, you need the following: - **Identity and access permissions**. Your user needs these roles assigned. [Learn more](https://techdocs.akamai.com/cloud-computing/docs/identity-access-cm-available-roles). - Roles: `lkecluster_viewer` - **OAuth scopes**. Your user needs these scopes assigned. [Learn more](https://techdocs.akamai.com/linode-api/reference/get-started#oauth). - Scopes: `lke:read_only` **CLI** ```shell linode-cli lke versions-list ``` [Learn more](https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli) - [Get an LKE Kubernetes version (non-enterprise)](https://techdocs.akamai.com/linode-api/reference/get-lke-version.md): View an LKE Kubernetes version available for deployment to a standard tier Kubernetes cluster. **Permissions and scopes** To call this operation, you need the following: - **Identity and access permissions**. Your user needs these roles assigned. [Learn more](https://techdocs.akamai.com/cloud-computing/docs/identity-access-cm-available-roles). - Roles: `lkecluster_viewer` - **OAuth scopes**. Your user needs these scopes assigned. [Learn more](https://techdocs.akamai.com/linode-api/reference/get-started#oauth). - Scopes: `lke:read_only` **CLI** ```shell linode-cli lke version-view 1.31 ``` [Learn more](https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli) - [List Kubernetes types](https://techdocs.akamai.com/linode-api/reference/get-lke-types.md): Returns Kubernetes types and prices, including any region-specific rates. **Permissions and scopes** To call this operation, you need the following: - **Identity and access permissions**. This operation is internet-facing. No permissions are required. **CLI** ```shell linode-cli lke types ``` [Learn more](https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli) - [List Kubernetes API endpoints](https://techdocs.akamai.com/linode-api/reference/get-lke-cluster-api-endpoints.md): List the Kubernetes API server endpoints for this cluster. Please note that it often takes 2-5 minutes before the endpoint is ready after first [creating a new cluster](ref:post-lke-cluster). **Permissions and scopes** To call this operation, you need the following: - **Identity and access permissions**. Your user needs these roles assigned. [Learn more](https://techdocs.akamai.com/cloud-computing/docs/identity-access-cm-available-roles). - Roles: `lkecluster_viewer` - **OAuth scopes**. Your user needs these scopes assigned. [Learn more](https://techdocs.akamai.com/linode-api/reference/get-started#oauth). - Scopes: `lke:read_only` **CLI** ```shell linode-cli lke api-endpoints-list 12345 ``` [Learn more](https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli) - [Create a StackScript](https://techdocs.akamai.com/linode-api/reference/post-add-stack-script.md): Creates a StackScript in your Account. **Permissions and scopes** To call this operation, you need the following: - **Identity and access permissions**. Your user needs these roles assigned. [Learn more](https://techdocs.akamai.com/cloud-computing/docs/identity-access-cm-available-roles). - Roles: `account_stackscript_creator` - **OAuth scopes**. Your user needs these scopes assigned. [Learn more](https://techdocs.akamai.com/linode-api/reference/get-started#oauth). - Scopes: `stackscripts:read_write` **CLI** ```shell linode-cli stackscripts create \ --label a-stackscript \ --description "This StackScript install and configures MySQL" \ --images "linode/debian13" \ --images "linode/debian13" \ --is_public true \ --rev_note "Set up MySQL" \ --script '#!/bin/bash' ``` [Learn more](https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli) - [List StackScripts](https://techdocs.akamai.com/linode-api/reference/get-stack-scripts.md): If the request is not authenticated, only public StackScripts are returned. For more information on StackScripts, please read our [StackScripts documentation](https://techdocs.akamai.com/cloud-computing/docs/stackscripts). **Permissions and scopes** To call this operation, you need the following: - **Identity and access permissions**. Your user needs these roles assigned. [Learn more](https://techdocs.akamai.com/cloud-computing/docs/identity-access-cm-available-roles). - Roles: `Public StackScripts are Internet facing, and Private StackScripts require the stackscript_viewer role` - **OAuth scopes**. Your user needs these scopes assigned. [Learn more](https://techdocs.akamai.com/linode-api/reference/get-started#oauth). - Scopes: `stackscripts:read_only` **CLI** ```shell linode-cli stackscripts list ``` [Learn more](https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli) - [Get a StackScript](https://techdocs.akamai.com/linode-api/reference/get-stack-script.md): Returns all of the information about a specified StackScript, including the contents of the script. **Permissions and scopes** To call this operation, you need the following: - **Identity and access permissions**. Your user needs these roles assigned. [Learn more](https://techdocs.akamai.com/cloud-computing/docs/identity-access-cm-available-roles). - Roles: `stackscript_viewer` - **OAuth scopes**. Your user needs these scopes assigned. [Learn more](https://techdocs.akamai.com/linode-api/reference/get-started#oauth). - Scopes: `stackscripts:read_only` **CLI** ```shell linode-cli stackscripts view 10079 ``` [Learn more](https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli) - [Update a StackScript](https://techdocs.akamai.com/linode-api/reference/put-stack-script.md): Updates a StackScript. __Once a StackScript is made public, it cannot be made private.__ **Permissions and scopes** To call this operation, you need the following: - **Identity and access permissions**. Your user needs these roles assigned. [Learn more](https://techdocs.akamai.com/cloud-computing/docs/identity-access-cm-available-roles). - Roles: `stackscript_admin` - **OAuth scopes**. Your user needs these scopes assigned. [Learn more](https://techdocs.akamai.com/linode-api/reference/get-started#oauth). - Scopes: `stackscripts:read_write` **CLI** ```shell linode-cli stackscripts update 10079 \ --label a-stackscript \ --description "This StackScript installs \ and configures MySQL" \ --images "linode/debian13" \ --images "linode/debian13" \ --is_public true \ --rev_note "Set up MySQL" \ --script '#!/bin/bash' ``` [Learn more](https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli) - [Delete a StackScript](https://techdocs.akamai.com/linode-api/reference/delete-stack-script.md): Deletes a private StackScript. You can't delete a public StackScript. **Permissions and scopes** To call this operation, you need the following: - **Identity and access permissions**. Your user needs these roles assigned. [Learn more](https://techdocs.akamai.com/cloud-computing/docs/identity-access-cm-available-roles). - Roles: `stackscript_admin` - **OAuth scopes**. Your user needs these scopes assigned. [Learn more](https://techdocs.akamai.com/linode-api/reference/get-started#oauth). - Scopes: `stackscripts:read_write` **CLI** ```shell linode-cli stackscripts delete 10079 ``` [Learn more](https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli) - [Create a Longview client](https://techdocs.akamai.com/linode-api/reference/post-longview-client.md): Creates a Longview Client. This Client will not begin monitoring the status of your server until you configure the Longview Client application on your Linode using the returning `install_code` and `api_key`. **Permissions and scopes** To call this operation, you need permissions, based on the model you're using: - **Identity and access permissions**. Your user needs a role with these permissions. [Learn more](https://techdocs.akamai.com/cloud-computing/docs/identity-access-cm-available-roles). - Roles: `account_longview_creator` - **OAuth scopes**. Your user needs these scopes assigned. [Learn more](https://techdocs.akamai.com/linode-api/reference/get-started#oauth). - Scopes: `longview:read_write` **CLI** ```shell linode-cli longview create \ --label client789 ``` [Learn more](https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli) - [List Longview clients](https://techdocs.akamai.com/linode-api/reference/get-longview-clients.md): Returns a paginated list of Longview Clients you have access to. Longview Client is used to monitor stats on your Linode with the help of the Longview Client application. **Permissions and scopes** To call this operation, you need permissions, based on the model you're using: - **Identity and access permissions**. Your user needs a role with these permissions. [Learn more](https://techdocs.akamai.com/cloud-computing/docs/identity-access-cm-available-roles). - Roles: `longview_viewer` - **OAuth scopes**. Your user needs these scopes assigned. [Learn more](https://techdocs.akamai.com/linode-api/reference/get-started#oauth). - Scopes: `longview:read_only` **CLI** ```shell linode-cli longview list ``` [Learn more](https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli) - [Get a Longview client](https://techdocs.akamai.com/linode-api/reference/get-longview-client.md): Returns a single Longview Client you can access. **Permissions and scopes** To call this operation, you need permissions, based on the model you're using: - **Identity and access permissions**. Your user needs a role with these permissions. [Learn more](https://techdocs.akamai.com/cloud-computing/docs/identity-access-cm-available-roles). - Roles: `longview_viewer` - **OAuth scopes**. Your user needs these scopes assigned. [Learn more](https://techdocs.akamai.com/linode-api/reference/get-started#oauth). - Scopes: `longview:read_only` **CLI** ```shell linode-cli longview view 789 ``` [Learn more](https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli) - [Update a Longview client](https://techdocs.akamai.com/linode-api/reference/put-longview-client.md): Updates a Longview Client. This cannot update how it monitors your server; use the Longview Client application on your Linode for monitoring configuration. **Permissions and scopes** To call this operation, you need permissions, based on the model you're using: - **Identity and access permissions**. Your user needs a role with these permissions. [Learn more](https://techdocs.akamai.com/cloud-computing/docs/identity-access-cm-available-roles). - Roles: `longview_admin` - **OAuth scopes**. Your user needs these scopes assigned. [Learn more](https://techdocs.akamai.com/linode-api/reference/get-started#oauth). - Scopes: `longview:read_write` **CLI** ```shell linode-cli longview update 789 \ --label client789 ``` [Learn more](https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli) - [Delete a Longview client](https://techdocs.akamai.com/linode-api/reference/delete-longview-client.md): Deletes a Longview Client from your Account. __All information stored for this client will be lost.__ This _does not_ uninstall the Longview Client application for your Linode - you must do that manually. **Permissions and scopes** To call this operation, you need permissions, based on the model you're using: - **Identity and access permissions**. Your user needs a role with these permissions. [Learn more](https://techdocs.akamai.com/cloud-computing/docs/identity-access-cm-available-roles). - Roles: `longview_admin` - **OAuth scopes**. Your user needs these scopes assigned. [Learn more](https://techdocs.akamai.com/linode-api/reference/get-started#oauth). - Scopes: `longview:read_write` **CLI** ```shell linode-cli longview delete 789 ``` [Learn more](https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli) - [Get a Longview plan](https://techdocs.akamai.com/linode-api/reference/get-longview-plan.md): Get the details of your current Longview plan. If your current plan is Longview Free, this operation returns an empty set `{}`. To update your subscription plan, send a request to [Update a Longview plan](ref:put-longview-plan). **Permissions and scopes** To call this operation, you need permissions, based on the model you're using: - **Identity and access permissions**. Your user needs a role with these permissions. [Learn more](https://techdocs.akamai.com/cloud-computing/docs/identity-access-cm-available-roles). - Roles: `longview_viewer` - **OAuth scopes**. Your user needs these scopes assigned. [Learn more](https://techdocs.akamai.com/linode-api/reference/get-started#oauth). - Scopes: `longview:read_only` **CLI** ```shell linode-cli longview plan-view ``` [Learn more](https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli) - [Update a Longview plan](https://techdocs.akamai.com/linode-api/reference/put-longview-plan.md): Update your Longview plan to that of the given subscription ID. If the updated plan is Longview Free, this operation returns an empty set `{}`. You can send a request to the [List Longview subscriptions](ref:get-longview-subscriptions) operation to receive the details, including `id`'s, of each plan. **Permissions and scopes** To call this operation, you need permissions, based on the model you're using: - **Identity and access permissions**. Your user needs a role with these permissions. [Learn more](https://techdocs.akamai.com/cloud-computing/docs/identity-access-cm-available-roles). - Roles: `account_longview_subscription_admin` - **OAuth scopes**. Your user needs these scopes assigned. [Learn more](https://techdocs.akamai.com/linode-api/reference/get-started#oauth). - Scopes: `longview:read_write` **CLI** ```shell linode-cli longview plan-update --longview_subscription longview-10 ``` [Learn more](https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli) - [List Longview subscriptions](https://techdocs.akamai.com/linode-api/reference/get-longview-subscriptions.md): Returns a paginated list of available Longview subscriptions. **Permissions and scopes** To call this operation, you need permissions, based on the model you're using: - **Identity and access permissions**. Your user needs a role with these permissions. [Learn more](https://techdocs.akamai.com/cloud-computing/docs/identity-access-cm-available-roles). - Roles: `longview_viewer` **CLI** ```shell linode-cli longview subscriptions-list ``` [Learn more](https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli) - [Get a Longview subscription](https://techdocs.akamai.com/linode-api/reference/get-longview-subscription.md): Get a specific Longview subscription plan. **Permissions and scopes** To call this operation, you need permissions, based on the model you're using: - **Identity and access permissions**. Your user needs a role with these permissions. [Learn more](https://techdocs.akamai.com/cloud-computing/docs/identity-access-cm-available-roles). - Roles: `longview_admin` **CLI** ```shell linode-cli longview subscription-view ``` [Learn more](https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli) - [List Longview types](https://techdocs.akamai.com/linode-api/reference/get-longview-types.md): Returns Longview types and prices, including any region-specific rates. **Permissions and scopes** To call this operation, you need permissions, based on the model you're using: - **Identity and access permissions**. Your user needs a role with these permissions. [Learn more](https://techdocs.akamai.com/cloud-computing/docs/identity-access-cm-available-roles). - Roles: `longview_viewer` **CLI** ```shell linode-cli longview types ``` [Learn more](https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli) - [List maintenance policies](https://techdocs.akamai.com/linode-api/reference/get-maintenance-policies.md): List all available maintenance policies that can be applied to your Linodes. **CLI** ```shell linode-cli maintenance policies-list ``` [Learn more](https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli) - [Create a managed contact](https://techdocs.akamai.com/linode-api/reference/post-managed-contact.md): Creates a managed contact. When investigating or resolving an issue with a service monitor, Akamai Support may reach out to this contact. This operation can only be accessed by the unrestricted users of an account. **Permissions and scopes** To call this operation, you need permissions, based on the model you're using: - **OAuth scopes**. Your user needs these scopes assigned. [Learn more](https://techdocs.akamai.com/linode-api/reference/get-started#oauth). - Scopes: `account:read_write` **CLI** ```shell linode-cli managed contact-create \ --name "John Doe" \ --email "john.doe@example.org" \ --phone.primary "123-456-7890" ``` [Learn more](https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli) - [List managed contacts](https://techdocs.akamai.com/linode-api/reference/get-managed-contacts.md): Returns a paginated list of managed contacts on your account. This operation can only be accessed by the unrestricted users of an account. **Permissions and scopes** To call this operation, you need permissions, based on the model you're using: - **OAuth scopes**. Your user needs these scopes assigned. [Learn more](https://techdocs.akamai.com/linode-api/reference/get-started#oauth). - Scopes: `account:read_only` **CLI** ```shell linode-cli managed contacts-list ``` [Learn more](https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli) - [Get a managed contact](https://techdocs.akamai.com/linode-api/reference/get-managed-contact.md): Returns a single managed contact. This operation can only be accessed by the unrestricted users of an account. **Permissions and scopes** To call this operation, you need permissions, based on the model you're using: - **OAuth scopes**. Your user needs these scopes assigned. [Learn more](https://techdocs.akamai.com/linode-api/reference/get-started#oauth). - Scopes: `account:read_write` **CLI** ```shell linode-cli managed contact-view 567 ``` [Learn more](https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli) - [Update a managed contact](https://techdocs.akamai.com/linode-api/reference/put-managed-contact.md): Updates information for a managed contact. This operation can only be accessed by the unrestricted users of an account. **Permissions and scopes** To call this operation, you need permissions, based on the model you're using: - **OAuth scopes**. Your user needs these scopes assigned. [Learn more](https://techdocs.akamai.com/linode-api/reference/get-started#oauth). - Scopes: `account:read_write` **CLI** ```shell linode-cli managed contact-update 567 \ --name "John Doe" \ --email "john.doe@example.org" \ --phone.primary "123-456-7890" ``` [Learn more](https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli) - [Delete a managed contact](https://techdocs.akamai.com/linode-api/reference/delete-managed-contact.md): Deletes a managed contact. This operation can only be accessed by the unrestricted users of an account. **Permissions and scopes** To call this operation, you need permissions, based on the model you're using: - **OAuth scopes**. Your user needs these scopes assigned. [Learn more](https://techdocs.akamai.com/linode-api/reference/get-started#oauth). - Scopes: `account:read_write` **CLI** ```shell linode-cli managed contact-delete 567 ``` [Learn more](https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli) - [Create a managed credential](https://techdocs.akamai.com/linode-api/reference/post-managed-credential.md): Creates a managed credential to store usernames and passwords for applications running on your Linode. Akamai Support can use these credentials to access your applications when investigating or resolving issues. This operation can only be accessed by the unrestricted users of an account. **Permissions and scopes** To call this operation, you need permissions, based on the model you're using: - **OAuth scopes**. Your user needs these scopes assigned. [Learn more](https://techdocs.akamai.com/linode-api/reference/get-started#oauth). - Scopes: `account:read_write` **CLI** ```shell linode-cli managed credential-create \ --label prod-password-1 \ --username johndoe \ --password s3cur3P@ssw0rd ``` [Learn more](https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli) - [List managed credentials](https://techdocs.akamai.com/linode-api/reference/get-managed-credentials.md): Returns a paginated list of managed credentials on your account. This operation can only be accessed by the unrestricted users of an account. **Permissions and scopes** To call this operation, you need permissions, based on the model you're using: - **OAuth scopes**. Your user needs these scopes assigned. [Learn more](https://techdocs.akamai.com/linode-api/reference/get-started#oauth). - Scopes: `account:read_only` **CLI** ```shell linode-cli managed credentials-list ``` [Learn more](https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli) - [Get a managed credential](https://techdocs.akamai.com/linode-api/reference/get-managed-credential.md): Returns a single Managed Credential. This operation can only be accessed by the unrestricted users of an account. **Permissions and scopes** To call this operation, you need permissions, based on the model you're using: - **OAuth scopes**. Your user needs these scopes assigned. [Learn more](https://techdocs.akamai.com/linode-api/reference/get-started#oauth). - Scopes: `account:read_write` **CLI** ```shell linode-cli managed credential-view 9991 ``` [Learn more](https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli) - [Update a managed credential](https://techdocs.akamai.com/linode-api/reference/put-managed-credential.md): Updates the label of a Managed Credential. This operation does not update the username and password for a Managed Credential. To do this, run the [Update a managed credential's username and password](ref:post-managed-credential-username-password)) operation instead. This operation can only be accessed by the unrestricted users of an account. **Permissions and scopes** To call this operation, you need permissions, based on the model you're using: - **OAuth scopes**. Your user needs these scopes assigned. [Learn more](https://techdocs.akamai.com/linode-api/reference/get-started#oauth). - Scopes: `account:read_write` **CLI** ```shell linode-cli managed credential-update 9991 \ --label prod-password-1 ``` [Learn more](https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli) - [Delete a managed credential](https://techdocs.akamai.com/linode-api/reference/post-managed-credential-revoke.md): Deletes a managed credential. Akamai Support will no longer have access to this credential when investigating or resolving issues. This operation can only be accessed by the unrestricted users of an account. **Permissions and scopes** To call this operation, you need permissions, based on the model you're using: - **OAuth scopes**. Your user needs these scopes assigned. [Learn more](https://techdocs.akamai.com/linode-api/reference/get-started#oauth). - Scopes: `account:read_write` **CLI** ```shell linode-cli managed credential-revoke 9991 ``` [Learn more](https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli) - [Update a managed credential's username and password](https://techdocs.akamai.com/linode-api/reference/post-managed-credential-username-password.md): Updates the username and password for a managed credential. This operation can only be accessed by the unrestricted users of an account. **Permissions and scopes** To call this operation, you need permissions, based on the model you're using: - **OAuth scopes**. Your user needs these scopes assigned. [Learn more](https://techdocs.akamai.com/linode-api/reference/get-started#oauth). - Scopes: `account:read_write` **CLI** ```shell linode-cli managed credential-update-username-password 9991 \ --username johndoe \ --password s3cur3P@ssw0rd ``` [Learn more](https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli) - [List managed Linode settings](https://techdocs.akamai.com/linode-api/reference/get-managed-linode-settings.md): Returns a paginated list of managed settings for your Linodes (one entry per Linode). This operation can only be accessed by the unrestricted users of an account. **Permissions and scopes** To call this operation, you need permissions, based on the model you're using: - **OAuth scopes**. Your user needs these scopes assigned. [Learn more](https://techdocs.akamai.com/linode-api/reference/get-started#oauth). - Scopes: `account:read_only` **CLI** ```shell linode-cli managed linode-settings-list ``` [Learn more](https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli) - [Get a Linode's managed settings](https://techdocs.akamai.com/linode-api/reference/get-managed-linode-setting.md): Returns the managed settings for a single Linode. This operation can only be accessed by the unrestricted users of an account. **Permissions and scopes** To call this operation, you need permissions, based on the model you're using: - **OAuth scopes**. Your user needs these scopes assigned. [Learn more](https://techdocs.akamai.com/linode-api/reference/get-started#oauth). - Scopes: `account:read_only` **CLI** ```shell linode-cli managed linode-setting-view 123 ``` [Learn more](https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli) - [Update a Linode's managed settings](https://techdocs.akamai.com/linode-api/reference/put-managed-linode-setting.md): Updates the managed settings for a Linode. This operation can only be accessed by the unrestricted users of an account. **Permissions and scopes** To call this operation, you need permissions, based on the model you're using: - **OAuth scopes**. Your user needs these scopes assigned. [Learn more](https://techdocs.akamai.com/linode-api/reference/get-started#oauth). - Scopes: `account:read_write` **CLI** ```shell linode-cli managed linode-setting-update \ 7833234 \ --ssh.access true \ --ssh.user linode \ --ssh.port 22 \ --ssh.ip 203.0.113.1 ``` [Learn more](https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli) - [List managed issues](https://techdocs.akamai.com/linode-api/reference/get-managed-issues.md): Returns a paginated list of recent and ongoing issues detected on your service monitors. This operation can only be accessed by the unrestricted users of an account. **Permissions and scopes** To call this operation, you need permissions, based on the model you're using: - **OAuth scopes**. Your user needs these scopes assigned. [Learn more](https://techdocs.akamai.com/linode-api/reference/get-started#oauth). - Scopes: `account:read_only` **CLI** ```shell linode-cli managed issues-list ``` [Learn more](https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli) - [Get a managed issue](https://techdocs.akamai.com/linode-api/reference/get-managed-issue.md): Returns a single issue affecting one of your service monitors. This operation can only be accessed by the unrestricted users of an account. **Permissions and scopes** To call this operation, you need permissions, based on the model you're using: - **OAuth scopes**. Your user needs these scopes assigned. [Learn more](https://techdocs.akamai.com/linode-api/reference/get-started#oauth). - Scopes: `account:read_only` **CLI** ```shell linode-cli managed issue-view 823 ``` [Learn more](https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli) - [Get a managed SSH key](https://techdocs.akamai.com/linode-api/reference/get-managed-ssh-key.md): Returns the unique SSH public key assigned to Linode Managed on your account. If you [add this public key](https://techdocs.akamai.com/cloud-computing/docs/configure-ssh-access-for-linode-managed) to a Linode on your account, Akamai Support can securely access that Linode to help resolve any issues. This operation can only be accessed by the unrestricted users of an account. **Permissions and scopes** To call this operation, you need permissions, based on the model you're using: - **OAuth scopes**. Your user needs these scopes assigned. [Learn more](https://techdocs.akamai.com/linode-api/reference/get-started#oauth). - Scopes: `account:read_only` **CLI** ```shell linode-cli managed credential-sshkey-view ``` [Learn more](https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli) - [Create a managed service](https://techdocs.akamai.com/linode-api/reference/post-managed-service.md): Creates a service monitor. Linode Managed monitors this service and alerts Akamai Support when issues are detected. This operation can only be accessed by the unrestricted users of an account. **Permissions and scopes** To call this operation, you need permissions, based on the model you're using: - **OAuth scopes**. Your user needs these scopes assigned. [Learn more](https://techdocs.akamai.com/linode-api/reference/get-started#oauth). - Scopes: `account:read_write` **CLI** ```shell linode-cli managed service-create \ --service_type url \ --label prod-1 \ --address "https://example.org" \ --timeout 30 \ --body "it worked" \ --consultation_group on-call \ --notes "The service name is \ my-cool-application" \ --credentials 9991 ``` [Learn more](https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli) - [List managed services](https://techdocs.akamai.com/linode-api/reference/get-managed-services.md): Returns a paginated list of service monitors on your account. These are the services on your Linodes monitored by Linode Managed. This operation can only be accessed by the unrestricted users of an account. **Permissions and scopes** To call this operation, you need permissions, based on the model you're using: - **OAuth scopes**. Your user needs these scopes assigned. [Learn more](https://techdocs.akamai.com/linode-api/reference/get-started#oauth). - Scopes: `account:read_only` **CLI** ```shell linode-cli managed services-list ``` [Learn more](https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli) - [Get a managed service](https://techdocs.akamai.com/linode-api/reference/get-managed-service.md): Returns the configuration settings for a single service monitor. This operation can only be accessed by the unrestricted users of an account. **Permissions and scopes** To call this operation, you need permissions, based on the model you're using: - **OAuth scopes**. Your user needs these scopes assigned. [Learn more](https://techdocs.akamai.com/linode-api/reference/get-started#oauth). - Scopes: `account:read_only` **CLI** ```shell linode-cli managed service-view 9994 ``` [Learn more](https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli) - [Update a managed service](https://techdocs.akamai.com/linode-api/reference/put-managed-service.md): Updates a service monitor's configuration settings. This operation can only be accessed by the unrestricted users of an account. **Permissions and scopes** To call this operation, you need permissions, based on the model you're using: - **OAuth scopes**. Your user needs these scopes assigned. [Learn more](https://techdocs.akamai.com/linode-api/reference/get-started#oauth). - Scopes: `account:read_write` **CLI** ```shell linode-cli managed service-update 9994 \ --service_type url \ --label prod-1 \ --address "https://example.org" \ --timeout 30 \ --body "it worked" \ --consultation_group on-call \ --notes "The service name is my-cool-application" \ --credentials 9991 ``` [Learn more](https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli) - [Delete a managed service](https://techdocs.akamai.com/linode-api/reference/delete-managed-service.md): Deletes a service monitor, so that the service is no longer monitored by Linode Managed. This operation can only be accessed by the unrestricted users of an account. **Permissions and scopes** To call this operation, you need permissions, based on the model you're using: - **OAuth scopes**. Your user needs these scopes assigned. [Learn more](https://techdocs.akamai.com/linode-api/reference/get-started#oauth). - Scopes: `account:read_write` **CLI** ```shell linode-cli managed service-delete 9994 ``` [Learn more](https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli) - [Disable a managed service](https://techdocs.akamai.com/linode-api/reference/post-disable-managed-service.md): Temporarily disables monitoring of a service on a managed Linode. This operation can only be accessed by the unrestricted users of an account. **Permissions and scopes** To call this operation, you need permissions, based on the model you're using: - **OAuth scopes**. Your user needs these scopes assigned. [Learn more](https://techdocs.akamai.com/linode-api/reference/get-started#oauth). - Scopes: `account:read_write` **CLI** ```shell linode-cli managed service-disable 9994 ``` [Learn more](https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli) - [Enable a managed service](https://techdocs.akamai.com/linode-api/reference/post-enable-managed-service.md): Enables monitoring of a service on a managed Linode. This operation can only be accessed by the unrestricted users of an account. **Permissions and scopes** To call this operation, you need permissions, based on the model you're using: - **OAuth scopes**. Your user needs these scopes assigned. [Learn more](https://techdocs.akamai.com/linode-api/reference/get-started#oauth). - Scopes: `account:read_write` **CLI** ```shell linode-cli managed service-enable 9994 ``` [Learn more](https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli) - [List managed stats](https://techdocs.akamai.com/linode-api/reference/get-managed-stats.md): Returns a list of metrics for the Linodes on your account in arrays of coordinates (_x_-axis and _y_-axis data points). You can use these data points to plot your own graph visualizations. These metrics reflect the last 24 hours of combined usage across all managed Linodes on your account, giving you a high-level snapshot of data for the following: - CPU - Disk I/O - Swap usage - Network in - Network out This operation can only be accessed by the unrestricted users of an account. **Permissions and scopes** To call this operation, you need permissions, based on the model you're using: - **OAuth scopes**. Your user needs these scopes assigned. [Learn more](https://techdocs.akamai.com/linode-api/reference/get-started#oauth). - Scopes: `account:read_only` **CLI** ```shell linode-cli managed stats-list ``` [Learn more](https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli) - [Create a Marketplace third-party referral](https://techdocs.akamai.com/linode-api/reference/post-marketplace-contact.md): __Beta__ Allows you as an Akamai customer to use our Marketplace application to request access to a third-party product offered by one of our qualified partners. Once the request is received, Akamai reaches out on your behalf for this access. Once approved, the qualified partner will contact you with details on accessing the product. > 📘 > > For available product information, access [Cloud Manager](https://cloud.linode.com), select **COMPUTE** > **Partner Referrals (BETA)** and review the product cards. Store the value listed in the partner logo as your `partner_name` and the full name of the product, listed below the logo, as your `product_name`. **Permissions and scopes** To call this operation, you need permissions, based on the model you're using: - **OAuth scopes**. Your user needs these scopes assigned. [Learn more](https://techdocs.akamai.com/linode-api/reference/get-started#oauth). - Scopes: `account:read_write` **CLI** ```shell linode-cli marketplace contacts-create \ --product_name DBaaS \ --partner_name Akamai \ --name "John Doe" \ --email "john.doe@example.org" \ --country_code US \ --phone_country_code +1 \ --phone 555 555 1234 \ --tc_consent_given true ``` [Learn more](https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli) - [List dashboards](https://techdocs.akamai.com/linode-api/reference/get-dashboards-all.md): __Limited availability__ Returns all available dashboards. > 📘 > > This operation has a specific [rate limit](ref:rate-limits#specific-operation-rate-limits). **Permissions and scopes** To call this operation, you need permissions, based on the model you're using: - **OAuth scopes**. Your user needs these scopes assigned. [Learn more](https://techdocs.akamai.com/linode-api/reference/get-started#oauth). - Scopes: `monitor:read_only` **CLI** ```shell linode-cli monitor dashboards-list-all ``` [Learn more](https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli) - [Get a dashboard](https://techdocs.akamai.com/linode-api/reference/get-dashboards-by-id.md): __Limited availability__ Returns a specific dashboard, based on its unique identifier. > 📘 > > This operation has a specific [rate limit](ref:rate-limits#specific-operation-rate-limits). **Permissions and scopes** To call this operation, you need permissions, based on the model you're using: - **OAuth scopes**. Your user needs these scopes assigned. [Learn more](https://techdocs.akamai.com/linode-api/reference/get-started#oauth). - Scopes: `monitor:read_only` **CLI** ```shell linode-cli monitor dashboards-view 1 ``` [Learn more](https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli) - [List supported service types](https://techdocs.akamai.com/linode-api/reference/get-monitor-services.md): __Limited availability__ Returns a paginated list of all current supported service types. > 📘 > > This operation has a specific [rate limit](ref:rate-limits#specific-operation-rate-limits). **Permissions and scopes** To call this operation, you need permissions, based on the model you're using: - **OAuth scopes**. Your user needs these scopes assigned. [Learn more](https://techdocs.akamai.com/linode-api/reference/get-started#oauth). - Scopes: `monitor:read_only` **CLI** ```shell linode-cli monitor service-list ``` [Learn more](https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli) - [Get details for a supported service type](https://techdocs.akamai.com/linode-api/reference/get-monitor-services-for-service-type.md): __Limited availability__ Returns details for a specific service type. > 📘 > > - This operation has a specific [rate limit](ref:rate-limits#specific-operation-rate-limits). > > - For more details on the metrics available for each service, see the [Metrics reference](https://techdocs.akamai.com/cloud-computing/docs/metrics-dimensions-parameters). **Permissions and scopes** To call this operation, you need permissions, based on the model you're using: - **OAuth scopes**. Your user needs these scopes assigned. [Learn more](https://techdocs.akamai.com/linode-api/reference/get-started#oauth). - Scopes: `monitor:read_only` **CLI** ```shell linode-cli monitor service-view dbaas ``` [Learn more](https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli) - [List dashboards for a service type](https://techdocs.akamai.com/linode-api/reference/get-dashboards.md): __Limited availability__ Returns all available dashboards for a given service type. > 📘 > > This operation has a specific [rate limit](ref:rate-limits#specific-operation-rate-limits). **Permissions and scopes** To call this operation, you need permissions, based on the model you're using: - **OAuth scopes**. Your user needs these scopes assigned. [Learn more](https://techdocs.akamai.com/linode-api/reference/get-started#oauth). - Scopes: `monitor:read_only` **CLI** ```shell linode-cli monitor dashboards-list dbaas ``` [Learn more](https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli) - [List metrics for a service type](https://techdocs.akamai.com/linode-api/reference/get-monitor-information.md): __Limited availability__ Returns metrics for a specific service type. > 📘 > > - This operation has a specific [rate limit](ref:rate-limits#specific-operation-rate-limits). > > - For more details on the metrics available for each service, see the [Metrics reference](https://techdocs.akamai.com/cloud-computing/docs/metrics-dimensions-parameters). **Permissions and scopes** To call this operation, you need permissions, based on the model you're using: - **OAuth scopes**. Your user needs these scopes assigned. [Learn more](https://techdocs.akamai.com/linode-api/reference/get-started#oauth). - Scopes: `monitor:read_only` **CLI** ```shell linode-cli monitor metrics-list dbaas ``` [Learn more](https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli) - [Create a token for a service type](https://techdocs.akamai.com/linode-api/reference/post-get-token.md): __Limited availability__ Returns a token that authenticates requests for the entities within a specific service type. To see your currently supported services, run the [List supported service types](ref:get-monitor-services) operation. The token has a lifetime of six hours after you create it. > 📘 > > When creating this token for Object Storage metrics, the token is accessible to all users on your account. > 👍 There's a tutorial > > We offer an [example](ref:get-started#authenticate-monitor-api-operations) you can follow to generate this token. **Permissions and scopes** To call this operation, you need permissions, based on the model you're using: - **OAuth scopes**. Your user needs these scopes assigned. [Learn more](https://techdocs.akamai.com/linode-api/reference/get-started#oauth). - Scopes: `monitor:read_only` **CLI** ```shell linode-cli monitor token-get dbaas \ --entity_ids 189690 \ --entity_ids 188020 --json ``` [Learn more](https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli) - [Get an entity's metrics](https://techdocs.akamai.com/linode-api/reference/post-read-metric.md): __Limited availability__ Returns metrics information for the individual entities within a specific service type. This operation also requires an `authorization: Bearer` [token](ref:post-get-token) you've created for this `serviceType`. > 📘 > > - This operation uses a different URL and version from standard Linode API operations. Verify you're using the URL with the `monitor-api.linode.com` hostname and include `v2` (or `v2beta`) as the version in the URL. > > - For more details on the metrics available for each service, see the [Metrics reference](https://techdocs.akamai.com/cloud-computing/docs/metrics-dimensions-parameters). - [Create an alert definition](https://techdocs.akamai.com/linode-api/reference/post-alert-definition-for-service-type.md): __Limited availability__ Create a new alert definition for a specific service type. Akamai refers to these as `user` alerts. Run the [List supported service types](ref:get-monitor-services) operation to see a list of services. **Permissions and scopes** To call this operation, you need permissions, based on the model you're using: - **OAuth scopes**. Your user needs these scopes assigned. [Learn more](https://techdocs.akamai.com/linode-api/reference/get-started#oauth). - Scopes: `monitor:read_write` **CLI** ```shell linode-cli alerts definition-create \ --channel_ids 546 \ --label CPU usage threshold maximum \ --rule_criteria.metric cpu_usage \ --rule_criteria.operator gt \ --rule_criteria.threshold 80 \ --severity 2 --trigger_conditions.evaluation_period_seconds 300 \ --trigger_conditions.polling_interval_seconds 300 \ --trigger_conditions.trigger_occurrences 3 \ ``` [Learn more](https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli) - [List alert definitions](https://techdocs.akamai.com/linode-api/reference/get-alert-definitions.md): __Limited availability__ Returns all available alert definitions on your account. > 📘 > > [Filtering](ref:filtering-and-sorting) is supported for specific objects, labeled as **Filterable**. However, only the `+and` and `+or` operators are supported, and you can't nest filter operators. **Permissions and scopes** To call this operation, you need permissions, based on the model you're using: - **OAuth scopes**. Your user needs these scopes assigned. [Learn more](https://techdocs.akamai.com/linode-api/reference/get-started#oauth). - Scopes: `monitor:read_only` **CLI** ```shell linode-cli alerts definitions-list-all ``` [Learn more](https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli) - [Get an alert definition](https://techdocs.akamai.com/linode-api/reference/get-alert-definition.md): __Limited availability__ Returns a specific alert definition. **Permissions and scopes** To call this operation, you need permissions, based on the model you're using: - **OAuth scopes**. Your user needs these scopes assigned. [Learn more](https://techdocs.akamai.com/linode-api/reference/get-started#oauth). - Scopes: `monitor:read_only` **CLI** ```shell linode-cli alerts definition-view dbaas 457 ``` [Learn more](https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli) - [Update an alert definition](https://techdocs.akamai.com/linode-api/reference/put-alert-definition.md): __Limited availability__ Update an existing alert definition. You need `read_only` access to the [OAuth scope](ref:get-started#oauth-reference) for the selected `serviceType`. Only include the objects in the request that you want to update. Leave any object out of the request to leave it set as is. When updating an alert definition you've [created](ref:post-alert-definition-for-service-type), you can change the `status` to `enabled` or `disabled`. You can also modify the `label`, `description`, and `severity`. You can't update a `scope`, but you can update its applicable `entity_ids` or `regions`, as well as its `rule_criteria`, `trigger_conditions`, and `channel_ids` objects. If updating the `rule_criteria`, `channel_ids`, `entity_ids`, or `regions` fields, these points apply: - If you want to keep an existing item, you need to include it in the list. - If you want to remove an existing item, leave it out of the list. - To add a new item, include it in the list. - You can't pass an empty list to remove all items. This doesn't apply to the `entity_ids`, `regions`, or `dimension_filters` (in `rule_criteria`) list objects, because they are optional, while all other list objects are required. **Permissions and scopes** To call this operation, you need permissions, based on the model you're using: - **OAuth scopes**. Your user needs these scopes assigned. [Learn more](https://techdocs.akamai.com/linode-api/reference/get-started#oauth). - Scopes: `monitor:read_write` **CLI** ```shell linode-cli alerts definition-update dbaas 457 \ --status disabled \ --label Read-Write Channel (old) ``` [Learn more](https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli) - [Clone an alert definition](https://techdocs.akamai.com/linode-api/reference/post-clone-alert-definition.md): __Limited availability__ Clone an existing alert definition, for a specific service type. Run the [List alert definitions](ref:get-alert-definitions) operation to see all of your available definitions. These points apply to cloning: - You need to set a new `label` for the clone. - You can clone your custom `user` alert definitions and preset Akamai `system` alert definition. Cloning a `system` alert definition generates a `user` alert definition. - Leave out optional fields from the request to keep existing settings from the clone source. If you include a field that allows you to apply multiple values, you need to include any existing values to keep them. Run the [Get an alert definition](ref:get-alert-definition) operation to see the current settings for your source. If you leave an existing value out, it's removed from the clone. - You can't change the `scope` for a cloned alert definition: - If the clone source `scope` is `region`, you can modify the `region` array to add or remove new regions. Leave this array out to create a new alert definition in the same regions. - If the clone source `scope` is `entity`, you can add new `entity_ids` to include additional entities. To remove current entities, leave their `entity_id` out. **Permissions and scopes** To call this operation, you need permissions, based on the model you're using: - **OAuth scopes**. Your user needs these scopes assigned. [Learn more](https://techdocs.akamai.com/linode-api/reference/get-started#oauth). - Scopes: `monitor:read_write` **CLI** ```shell linode-cli alerts definition-clone dbaas 457 \ --label Read-Write Channel (clone) --description New alert definition cloned from Read-Write Channel --regions us-iad ``` [Learn more](https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli) - [List alert definitions for a service type](https://techdocs.akamai.com/linode-api/reference/get-alert-definitions-for-service-type.md): __Limited availability__ Returns all available alert definitions for a specific service type. **Permissions and scopes** To call this operation, you need permissions, based on the model you're using: - **OAuth scopes**. Your user needs these scopes assigned. [Learn more](https://techdocs.akamai.com/linode-api/reference/get-started#oauth). - Scopes: `monitor:read_only` **CLI** ```shell linode-cli alerts service-definitions-list dbaas ``` [Learn more](https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli) - [List entities assigned to an alert definition](https://techdocs.akamai.com/linode-api/reference/get-alert-definition-entities.md): __Limited availability__ Returns all entities for a specific alert definition used by a specific Akamai Cloud Computing service. **Permissions and scopes** To call this operation, you need permissions, based on the model you're using: - **OAuth scopes**. Your user needs these scopes assigned. [Learn more](https://techdocs.akamai.com/linode-api/reference/get-started#oauth). - Scopes: `monitor:read_only` **CLI** ```shell linode-cli alerts definition-entities-list dbaas 457 ``` [Learn more](https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli) - [Delete an alert definition](https://techdocs.akamai.com/linode-api/reference/delete-alert-definition.md): __Limited availability__ Delete a specific alert definition on your account. > 📘 > > - You need `read_only` access to the [OAuth scope](ref:get-started#oauth-reference) for the target `serviceType`. > > - An [alert definition](ref:get-alert-definitions) with a `type` of `system` can't be deleted. **Permissions and scopes** To call this operation, you need permissions, based on the model you're using: - **OAuth scopes**. Your user needs these scopes assigned. [Learn more](https://techdocs.akamai.com/linode-api/reference/get-started#oauth). - Scopes: `monitor:read_write` **CLI** ```shell linode-cli alerts definition-delete dbaas 123 ``` [Learn more](https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli) - [Create a notification channel](https://techdocs.akamai.com/linode-api/reference/post-notification-channel.md): __Limited availability__ Create a new notification channel, to set up a communication method for a monitoring alert. This is referred to as a `user` channel and you can have a maximum of five on your account. **Permissions and scopes** To call this operation, you need permissions, based on the model you're using: - **OAuth scopes**. Your user needs these scopes assigned. [Learn more](https://techdocs.akamai.com/linode-api/reference/get-started#oauth). - Scopes: `monitor:read_write` **CLI** ```shell linode-cli alerts channels-create --label Email channel for Managed Database alerts \ --channel_type email \ --details.email.usernames johndoe \ --details.email.usernames janedoe ``` [Learn more](https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli) - [List notification channels](https://techdocs.akamai.com/linode-api/reference/get-notification-channels.md): __Limited availability__ Returns all of the monitoring alert notification channels available to your user. A notification channel is a method of communication used to send a monitoring alert. > 📘 > > [Filtering](ref:filtering-and-sorting) is supported for specific objects, labeled as **Filterable**. However, only the `+and` and `+or` operators are supported, and you can't nest filter operators. **Permissions and scopes** To call this operation, you need permissions, based on the model you're using: - **OAuth scopes**. Your user needs these scopes assigned. [Learn more](https://techdocs.akamai.com/linode-api/reference/get-started#oauth). - Scopes: `monitor:read_only` **CLI** ```shell linode-cli alerts channels-list ``` [Learn more](https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli) - [Get a notification channel](https://techdocs.akamai.com/linode-api/reference/get-notification-channel.md): __Limited availability__ Returns a specific monitoring alerts notification channel. A notification channel is the method of communication used to send a monitoring alert. **Permissions and scopes** To call this operation, you need permissions, based on the model you're using: - **OAuth scopes**. Your user needs these scopes assigned. [Learn more](https://techdocs.akamai.com/linode-api/reference/get-started#oauth). - Scopes: `monitor:read_only` **CLI** ```shell linode-cli alerts channels-view 754 ``` [Learn more](https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli) - [Update a notification channel](https://techdocs.akamai.com/linode-api/reference/put-notification-channel.md): __Limited availability__ Update an existing monitoring alert notification channel. A notification channel is the method of communication used to send a monitoring alert. > 📘 > > - To maintain existing settings in a notification channel, you need to provide them when updating an object. For example, if you have a `channel_type` of `email` with `johndoe` and `janedoe` currently set as `usernames`, you need to include them if you're updating the `usernames` object with a new value. Run the [Get notification channel](ref:get-notification-channel) operation and review the channel's existing settings. > > - You can't change the `channel_type` for an existing notification channel. > > - You can't update the default notification channel, or a `system` notification channel. **Permissions and scopes** To call this operation, you need permissions, based on the model you're using: - **OAuth scopes**. Your user needs these scopes assigned. [Learn more](https://techdocs.akamai.com/linode-api/reference/get-started#oauth). - Scopes: `monitor:read_write` **CLI** ```shell linode-cli alerts channels-update 754 --details.email.usernames johndoe / --details.email.usernames janedoe / --details.email.usernames bobdoe ``` [Learn more](https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli) - [List alerts for a notification channel](https://techdocs.akamai.com/linode-api/reference/get-notification-channel-alerts.md): __Limited availability__ Returns all monitoring alerts definitions that use a specific notification channel. **Permissions and scopes** To call this operation, you need permissions, based on the model you're using: - **OAuth scopes**. Your user needs these scopes assigned. [Learn more](https://techdocs.akamai.com/linode-api/reference/get-started#oauth). - Scopes: `monitor:read_only` **CLI** ```shell linode-cli alerts channels-alerts-list 754 ``` [Learn more](https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli) - [Delete a notification channel](https://techdocs.akamai.com/linode-api/reference/delete-notification-channel.md): __Limited availability__ Delete a specific monitoring alert notification channel with a `type` of `user`. You can't delete a `system` notification channel. You also can't delete a `user` channel that's actively used in an alert: 1. Run the [List alerts for a notification channel](ref:get-alerts-for-an-alert-channel) operation, using the stored `channelId` for your notification channel. 2. Store the `id` for each alert that uses the notification channel. 3. Run the [Update an alert definition](ref:put-alert-definition) operation for each stored alert `id`. Include the `channel_ids` object in the request and ensure that the notification `channelId` is _left out_. This removes the notification channel from the alert definition. **Permissions and scopes** To call this operation, you need permissions, based on the model you're using: - **OAuth scopes**. Your user needs these scopes assigned. [Learn more](https://techdocs.akamai.com/linode-api/reference/get-started#oauth). - Scopes: `monitor:read_write` **CLI** ```shell linode-cli alerts channels-delete 754 ``` [Learn more](https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli) - [Create a destination](https://techdocs.akamai.com/linode-api/reference/post-destination.md): Create a new destination to serve as a sync point for logs data. You need a destination, before you can create a stream. This operation can only be accessed by account [users](ref:get-users) with _unrestricted_ access. Talk to your local account administrator about access management. > 🚧 > > By using this service, you acknowledge your obligations under the United States Department of Justice Bulk Sensitive Data Transaction Rule ("BSD Rule"). You also agree that you will not use the service to transfer, onward transfer, or otherwise make accessible any United States government-related data or bulk United States sensitive personal data to countries of concern or a covered person, as each of those terms and concepts are defined in the [BSD Rule](https://www.federalregister.gov/documents/2024/03/01/2024-04573/preventing-access-to-americans-bulk-sensitive-personal-data-and-united-states-government-related). Anyone using the service is solely responsible for compliance with the BSD Rule. > 👍 There's a tutorial > > We offer an example API [workflow](ref:configure-audit-log-delivery) you can follow to set up a stream and its destination. **Permissions and scopes** To call this operation, you need permissions, based on the model you're using: - **OAuth scopes**. Your user needs these scopes assigned. [Learn more](https://techdocs.akamai.com/linode-api/reference/get-started#oauth). - Scopes: `monitor:read_write` **CLI** ```shell linode-cli streams destination-create \ --label destination for Managed Database logs \ --details.host primary-bucket-1.us-east-12.linodeobjects.com \ --details.bucket_name primary-bucket \ --details.path audit-logs \ --details.access_key_id 123 ``` [Learn more](https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli) - [List destinations](https://techdocs.akamai.com/linode-api/reference/get-destinations.md): Returns all available logs destinations. Destinations are used as sync points for log data. This operation can only be accessed by account [users](ref:get-users) with _unrestricted_ access. Talk to your local account administrator about access management. **Permissions and scopes** To call this operation, you need permissions, based on the model you're using: - **OAuth scopes**. Your user needs these scopes assigned. [Learn more](https://techdocs.akamai.com/linode-api/reference/get-started#oauth). - Scopes: `monitor:read_only` **CLI** ```shell linode-cli streams destinations-list ``` [Learn more](https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli) - [Get a destination](https://techdocs.akamai.com/linode-api/reference/get-destination.md): Returns a specific logs destination. This operation can only be accessed by account [users](ref:get-users) with _unrestricted_ access. Talk to your local account administrator about access management. **Permissions and scopes** To call this operation, you need permissions, based on the model you're using: - **OAuth scopes**. Your user needs these scopes assigned. [Learn more](https://techdocs.akamai.com/linode-api/reference/get-started#oauth). - Scopes: `monitor:read_only` **CLI** ```shell linode-cli streams destination-view 456 ``` [Learn more](https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli) - [Update a destination](https://techdocs.akamai.com/linode-api/reference/put-destination.md): Update an existing logs destination. Include the appropriate `destinationId` as a path parameter. This operation can only be accessed by account [users](ref:get-users) with _unrestricted_ access. Talk to your local account administrator about access management. > 🚧 > > By using this service, you acknowledge your obligations under the United States Department of Justice Bulk Sensitive Data Transaction Rule ("BSD Rule"). You also agree that you will not use the service to transfer, onward transfer, or otherwise make accessible any United States government-related data or bulk United States sensitive personal data to countries of concern or a covered person, as each of those terms and concepts are defined in the [BSD Rule](https://www.federalregister.gov/documents/2024/03/01/2024-04573/preventing-access-to-americans-bulk-sensitive-personal-data-and-united-states-government-related). Anyone using the service is solely responsible for compliance with the BSD Rule. **Permissions and scopes** To call this operation, you need permissions, based on the model you're using: - **OAuth scopes**. Your user needs these scopes assigned. [Learn more](https://techdocs.akamai.com/linode-api/reference/get-started#oauth). - Scopes: `monitor:read_write` **CLI** ```shell linode-cli streams destination-update 456 \ --label New destination for Managed Database logs \ --details.host secondary-bucket-1.us-east-12.linodeobjects.com \ --details.bucket_name secondary-bucket \ --details.region us-east \ --details.path audit-logs \ --details.access_key_id 456 ``` [Learn more](https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli) - [Get a destination's history](https://techdocs.akamai.com/linode-api/reference/get-destination-history.md): Returns all versions of a specific logs destination. Versions are listed in ascending order. This operation can only be accessed by account [users](ref:get-users) with _unrestricted_ access. Talk to your local account administrator about access management. **Permissions and scopes** To call this operation, you need permissions, based on the model you're using: - **OAuth scopes**. Your user needs these scopes assigned. [Learn more](https://techdocs.akamai.com/linode-api/reference/get-started#oauth). - Scopes: `monitor:read_only` **CLI** ```shell linode-cli streams destination-history-view 456 ``` [Learn more](https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli) - [Delete a destination](https://techdocs.akamai.com/linode-api/reference/delete-destination.md): Delete a specific logs destination. Include the appropriate `destinationId` as a path parameter. This operation can only be accessed by account [users](ref:get-users) with _unrestricted_ access. Talk to your local account administrator about access management. You can't delete a destination that's part of an active logs stream: 1. With your target `destinationId` stored, run the [List streams](ref:get-stream) operation and store the `id` for all streams that are using the destination. 2. Run the [Update a stream](ref:put-stream) operation for each stored stream `id`, and remove the target destination. **Permissions and scopes** To call this operation, you need permissions, based on the model you're using: - **OAuth scopes**. Your user needs these scopes assigned. [Learn more](https://techdocs.akamai.com/linode-api/reference/get-started#oauth). - Scopes: `monitor:read_write` **CLI** ```shell linode-cli destination-delete 456 ``` [Learn more](https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli) - [Create a stream](https://techdocs.akamai.com/linode-api/reference/post-stream.md): Create a new stream to track logs for an Akamai Cloud Computing service. Consider these points before creating a stream: - You first need to [create the destination](ref:post-destination) where you want to store log data. - By default, you can only set up a single stream for each audit log type. Talk to your account team if you need additional streams. - This operation can only be accessed by account [users](ref:get-users) with _unrestricted_ access. Talk to your local account administrator about access management. > 🚧 > > By using this service, you acknowledge your obligations under the United States Department of Justice Bulk Sensitive Data Transaction Rule ("BSD Rule"). You also agree that you will not use the service to transfer, onward transfer, or otherwise make accessible any United States government-related data or bulk United States sensitive personal data to countries of concern or a covered person, as each of those terms and concepts are defined in the [BSD Rule](https://www.federalregister.gov/documents/2024/03/01/2024-04573/preventing-access-to-americans-bulk-sensitive-personal-data-and-united-states-government-related). Anyone using the service is solely responsible for compliance with the BSD Rule. > 👍 There's a tutorial > > We offer an example API [workflow](ref:config-audit-log-delivery) you can follow to set up a stream and its destination. **Permissions and scopes** To call this operation, you need permissions, based on the model you're using: - **OAuth scopes**. Your user needs these scopes assigned. [Learn more](https://techdocs.akamai.com/linode-api/reference/get-started#oauth). - Scopes: `monitor:read_write` **CLI** ```shell linode-cli streams create \ --label Logs stream for Managed Databases \ --type audit_logs \ --destinations 12345 \ ``` [Learn more](https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli) - [List streams](https://techdocs.akamai.com/linode-api/reference/get-streams.md): Returns all available streams used for log-tracking with your Akamai Cloud Computing services. This operation can only be accessed by account [users](ref:get-users) with _unrestricted_ access. Talk to your local account administrator about access management. **Permissions and scopes** To call this operation, you need permissions, based on the model you're using: - **OAuth scopes**. Your user needs these scopes assigned. [Learn more](https://techdocs.akamai.com/linode-api/reference/get-started#oauth). - Scopes: `monitor:read_only` **CLI** ```shell linode-cli streams list ``` [Learn more](https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli) - [Get a stream](https://techdocs.akamai.com/linode-api/reference/get-stream.md): Returns a specific logs stream. Include the appropriate `streamId` as a path parameter. Run the [List streams](ref:get-streams) operation and store the `id` for the applicable one. This operation can only be accessed by account [users](ref:get-users) with _unrestricted_ access. Talk to your local account administrator about access management. **Permissions and scopes** To call this operation, you need permissions, based on the model you're using: - **OAuth scopes**. Your user needs these scopes assigned. [Learn more](https://techdocs.akamai.com/linode-api/reference/get-started#oauth). - Scopes: `monitor:read_only` **CLI** ```shell linode-cli streams view 890 ``` [Learn more](https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli) - [Update a stream](https://techdocs.akamai.com/linode-api/reference/put-stream.md): Update an existing logs stream. You can't update a stream's `type`. This operation can only be accessed by account [users](ref:get-users) with _unrestricted_ access. Talk to your local account administrator about access management. > 🚧 > > By using this service, you acknowledge your obligations under the United States Department of Justice Bulk Sensitive Data Transaction Rule ("BSD Rule"). You also agree that you will not use the service to transfer, onward transfer, or otherwise make accessible any United States government-related data or bulk United States sensitive personal data to countries of concern or a covered person, as each of those terms and concepts are defined in the [BSD Rule](https://www.federalregister.gov/documents/2024/03/01/2024-04573/preventing-access-to-americans-bulk-sensitive-personal-data-and-united-states-government-related). Anyone using the service is solely responsible for compliance with the BSD Rule. **Permissions and scopes** To call this operation, you need permissions, based on the model you're using: - **OAuth scopes**. Your user needs these scopes assigned. [Learn more](https://techdocs.akamai.com/linode-api/reference/get-started#oauth). - Scopes: `monitor:read_write` **CLI** ```shell linode-cli streams update 890 \ --label Logs stream for Managed Databases \ --status inactive \ --destinations 12345 ``` [Learn more](https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli) - [Get a stream's history](https://techdocs.akamai.com/linode-api/reference/get-stream-history.md): Returns all versions of a specific logs stream. Include the appropriate `streamId` as a path parameter. This operation can only be accessed by account [users](ref:get-users) with _unrestricted_ access. Talk to your local account administrator about access management. **Permissions and scopes** To call this operation, you need permissions, based on the model you're using: - **OAuth scopes**. Your user needs these scopes assigned. [Learn more](https://techdocs.akamai.com/linode-api/reference/get-started#oauth). - Scopes: `monitor:read_only` **CLI** ```shell linode-cli streams history-view 456 ``` [Learn more](https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli) - [Delete a stream](https://techdocs.akamai.com/linode-api/reference/delete-stream.md): Delete a specific logs stream. Include the appropriate `streamId` as a path parameter. Run the [List streams](ref:get-streams) operation and store the `id` for the applicable one. This operation can only be accessed by account [users](ref:get-users) with _unrestricted_ access. Talk to your local account administrator about access management. **Permissions and scopes** To call this operation, you need permissions, based on the model you're using: - **OAuth scopes**. Your user needs these scopes assigned. [Learn more](https://techdocs.akamai.com/linode-api/reference/get-started#oauth). - Scopes: `monitor:read_write` **CLI** ```shell linode-cli streams delete 890 ``` [Learn more](https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli) - [List network transfer prices](https://techdocs.akamai.com/linode-api/reference/get-network-transfer-prices.md): Returns collection of network transfer prices, including any region-specific rates. **Permissions and scopes** To call this operation, you need the following: - **Identity and access permissions**. This operation is internet-facing. No permissions are required. **CLI** ```shell linode-cli network-transfer prices ``` [Learn more](https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli) - [Create a firewall](https://techdocs.akamai.com/linode-api/reference/post-firewalls.md): Creates a Firewall to filter network traffic. - Use `rules` to create inbound and outbound access rules. Rule versions increment from `1` whenever the firewall's `rules` change. - Use `devices` to assign a firewall to a service such as a Linode that is using legacy config profiles, a public Linode interface, a regular VPC Linode interface, or a NodeBalancer. The firewall’s rules are then applied to that service. - For Linodes using Linode interfaces, firewalls need to be assigned to `interfaces` and not the `linodes`. Firewall templates are available for both regular VPC Linode interfaces and public Linode interfaces, and come with pre-configured protection rules. - For Linodes using legacy configuration profiles, firewalls are applied through the Linode. Public and VPC interfaces are subject to the firewall rules, while VLAN interfaces are not. - Currently, firewalls can be assigned to Linodes with legacy configuration profiles, public or regular VPC Linode interfaces, and NodeBalancers. - The same firewall can be assigned to multiple services at a time. - Use `firewall_id` to assign a firewall when [creating a Linode](ref:post-linode-instance) or when [adding a Linode interface](ref:post-linode-interface). - A service can have one assigned firewall enabled at a time. - Assigned Linodes must not have any ongoing live migrations. - A `firewall_create` event is generated when this operation succeeds. **Permissions and scopes** To call this operation, you need permissions, based on the model you're using: - **Identity and access permissions**. Your user needs a role with these permissions. [Learn more](https://techdocs.akamai.com/cloud-computing/docs/identity-access-cm-available-roles). - Permissions: `create_firewall` - **OAuth scopes**. Your user needs these scopes assigned. [Learn more](https://techdocs.akamai.com/linode-api/reference/get-started#oauth). - Scopes: `firewall:read_write` **CLI** ```shell linode-cli firewalls create \ --label example-firewall \ --rules.outbound_policy ACCEPT \ --rules.inbound_policy DROP \ --rules.inbound '[{"protocol": "TCP", "ports": "22, 80, 8080, 443", "addresses": {"ipv4": ["192.0.2.0/24", "198.51.100.2/32"], "ipv6": ["2001:DB8::/128"]}, "action": "ACCEPT"}]' \ --rules.outbound '[{"protocol": "TCP", "ports": "49152-65535", "addresses": {"ipv4": ["192.0.2.0/24", "198.51.100.2/32"],"ipv6": ["2001:DB8::/128"]}, "action": "DROP", "label": "outbound-rule123", "description": "An example outbound rule description."}]' ``` [Learn more](https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli) - [List firewalls](https://techdocs.akamai.com/linode-api/reference/get-firewalls.md): Returns a paginated list of accessible Firewalls. **Permissions and scopes** To call this operation, you need permissions, based on the model you're using: - **Identity and access permissions**. Your user needs a role with these permissions. [Learn more](https://techdocs.akamai.com/cloud-computing/docs/identity-access-cm-available-roles). - Permissions: `view_firewall` - **OAuth scopes**. Your user needs these scopes assigned. [Learn more](https://techdocs.akamai.com/linode-api/reference/get-started#oauth). - Scopes: `firewall:read_only` **CLI** ```shell linode-cli firewalls list ``` [Learn more](https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli) - [Get a firewall](https://techdocs.akamai.com/linode-api/reference/get-firewall.md): Get a specific Firewall resource by its ID. The Firewall's Devices will not be returned in the response. Instead, run the [List firewall devices](ref:get-firewall-devices) operation to review them. **Permissions and scopes** To call this operation, you need permissions, based on the model you're using: - **Identity and access permissions**. Your user needs a role with these permissions. [Learn more](https://techdocs.akamai.com/cloud-computing/docs/identity-access-cm-available-roles). - Permissions: `view_firewall` - **OAuth scopes**. Your user needs these scopes assigned. [Learn more](https://techdocs.akamai.com/linode-api/reference/get-started#oauth). - Scopes: `firewall:read_only` **CLI** ```shell linode-cli firewalls view 123 ``` [Learn more](https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli) - [Update a firewall](https://techdocs.akamai.com/linode-api/reference/put-firewall.md): Updates information for a firewall. - Assigned Linodes must not have any ongoing live migrations. - If this operation changes a firewall's status, it generates a corresponding `firewall_enable` or `firewall_disable` event. This operation doesn't affect some parts of a firewall's configuration: - This operation doesn't set a firewall's devices. Instead, run the [Create a firewall device](ref:post-firewall-device) and [Delete a firewall device](ref:delete-firewall-device) operations to assign and remove this firewall from services. - A firewall's rules can't be changed with this operation. Instead, run the [Update firewall rules](ref:put-firewall-rules) operation to update your rules. - Use this operation to set a firewall's status to `enabled` or `disabled`. But to set it to `deleted`, run the [Delete a firewall](ref:delete-firewall) operation. - An assigned default firewall can't be disabled. **Permissions and scopes** To call this operation, you need permissions, based on the model you're using: - **Identity and access permissions**. Your user needs a role with these permissions. [Learn more](https://techdocs.akamai.com/cloud-computing/docs/identity-access-cm-available-roles). - Permissions: `update_firewall` - **OAuth scopes**. Your user needs these scopes assigned. [Learn more](https://techdocs.akamai.com/linode-api/reference/get-started#oauth). - Scopes: `firewall:read_write` **CLI** ```shell linode-cli firewalls update 123 \ --status disabled ``` [Learn more](https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli) - [Delete a firewall](https://techdocs.akamai.com/linode-api/reference/delete-firewall.md): Delete a firewall. This also removes all of the firewall's rules from any services the firewall was assigned to. - Assigned Linodes must not have any ongoing live migrations. - A `firewall_delete` event is generated when this operation returns successfully. - An assigned default firewall can't be deleted. **Permissions and scopes** To call this operation, you need permissions, based on the model you're using: - **Identity and access permissions**. Your user needs a role with these permissions. [Learn more](https://techdocs.akamai.com/cloud-computing/docs/identity-access-cm-available-roles). - Permissions: `delete_firewall` - **OAuth scopes**. Your user needs these scopes assigned. [Learn more](https://techdocs.akamai.com/linode-api/reference/get-started#oauth). - Scopes: `firewall:read_write` **CLI** ```shell linode-cli firewalls delete 123 ``` [Learn more](https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli) - [List firewall rule versions](https://techdocs.akamai.com/linode-api/reference/get-firewall-rule-versions.md): Lists the current and historical rules of the firewall (that is not deleted), using `version`. Whenever rules update, the `version` increments from `1`. **Permissions and scopes** To call this operation, you need permissions, based on the model you're using: - **Identity and access permissions**. Your user needs a role with these permissions. [Learn more](https://techdocs.akamai.com/cloud-computing/docs/identity-access-cm-available-roles). - Permissions: `list_firewall_rule_versions` - **OAuth scopes**. Your user needs these scopes assigned. [Learn more](https://techdocs.akamai.com/linode-api/reference/get-started#oauth). - Scopes: `firewall:read_only` **CLI** ```shell linode-cli firewalls versions-list 123 ``` [Learn more](https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli) - [Get a firewall rule version](https://techdocs.akamai.com/linode-api/reference/get-firewall-rule-version.md): Get a specific firewall rule version for an `enabled` or `disabled` firewall. **Permissions and scopes** To call this operation, you need permissions, based on the model you're using: - **OAuth scopes**. Your user needs these scopes assigned. [Learn more](https://techdocs.akamai.com/linode-api/reference/get-started#oauth). - Scopes: `firewall:read_only` **CLI** ```shell linode-cli firewalls version-view \ 123 2 ``` [Learn more](https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli) - [List firewall rules](https://techdocs.akamai.com/linode-api/reference/get-firewall-rules.md): Returns the inbound and outbound Rules for a Firewall. **Permissions and scopes** To call this operation, you need permissions, based on the model you're using: - **Identity and access permissions**. Your user needs a role with these permissions. [Learn more](https://techdocs.akamai.com/cloud-computing/docs/identity-access-cm-available-roles). - Permissions: `list_firewall_rules` - **OAuth scopes**. Your user needs these scopes assigned. [Learn more](https://techdocs.akamai.com/linode-api/reference/get-started#oauth). - Scopes: `firewall:read_only` **CLI** ```shell linode-cli firewalls rules-list 123 ``` [Learn more](https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli) - [Update firewall rules](https://techdocs.akamai.com/linode-api/reference/put-firewall-rules.md): Updates the inbound and outbound Rules for a Firewall. - Assigned Linodes must not have any ongoing live migrations. - __Note__. This operation replaces all of a Firewall's `inbound` and `outbound` rulesets with the values specified in your request. **Permissions and scopes** To call this operation, you need permissions, based on the model you're using: - **Identity and access permissions**. Your user needs a role with these permissions. [Learn more](https://techdocs.akamai.com/cloud-computing/docs/identity-access-cm-available-roles). - Permissions: `update_firewall_rules` - **OAuth scopes**. Your user needs these scopes assigned. [Learn more](https://techdocs.akamai.com/linode-api/reference/get-started#oauth). - Scopes: `firewall:read_write` **CLI** ```shell linode-cli firewalls rules-update 123 \ --inbound '[{"action":"ACCEPT", "protocol": "TCP", "ports": "22, 80, 8080, 443", "addresses": {"ipv4": ["192.0.2.0/24", "198.51.100.2/32"], "ipv6": ["2001:DB8::/128"]}}]' \ --outbound '[{"action":"DROP","protocol": "TCP", "ports": "49152-65535", "addresses": {"ipv4": ["192.0.2.0/24", "198.51.100.2/32"], "ipv6": ["2001:DB8::/128`"]}}]' ``` [Learn more](https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli) - [List default firewalls](https://techdocs.akamai.com/linode-api/reference/get-firewall-settings.md): Returns default firewalls for Linodes, Linode VPC and public interfaces, and NodeBalancers. **Permissions and scopes** To call this operation, you need permissions, based on the model you're using: - **Identity and access permissions**. Your user needs a role with these permissions. [Learn more](https://techdocs.akamai.com/cloud-computing/docs/identity-access-cm-available-roles). - Permissions: `list_default_firewalls` - **OAuth scopes**. Your user needs these scopes assigned. [Learn more](https://techdocs.akamai.com/linode-api/reference/get-started#oauth). - Scopes: `firewall:read_only` **CLI** ```shell linode-cli firewalls firewall-settings-list ``` [Learn more](https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli) - [Update default firewalls](https://techdocs.akamai.com/linode-api/reference/put-firewall-settings.md): You can update or add a default firewall to: - Linodes using legacy config profile interfaces - Linode VPC interfaces and Linode public interfaces - NodeBalancers If a firewall isn't provided during service creation, a default firewall is assigned, unless you have opted out of firewall protection. > 📘 > > Default firewalls on Linodes with Linode interfaces are applied to the interfaces, not the Linode itself. > > Default firewalls on Linodes with legacy configuration profile interfaces are applied directly to the Linode, not its interfaces. **Permissions and scopes** To call this operation, you need permissions, based on the model you're using: - **Identity and access permissions**. Your user needs a role with these permissions. [Learn more](https://techdocs.akamai.com/cloud-computing/docs/identity-access-cm-available-roles). - Permissions: `update_default_firewalls` - **OAuth scopes**. Your user needs these scopes assigned. [Learn more](https://techdocs.akamai.com/linode-api/reference/get-started#oauth). - Scopes: `account:read_write` **CLI** ```shell linode-cli firewalls firewall-settings-update \ --default_firewall_ids.vpc_interface 1 \ --default_firewall_ids.public_interface 2 \ --default_firewall_ids.nodebalancer 3 \ --default_firewall_ids.linode 5 ``` [Learn more](https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli) - [List firewall templates](https://techdocs.akamai.com/linode-api/reference/get-firewall-templates.md): Returns a paginated list of a firewall templates. There are firewall templates specifically for VPC interfaces and public interfaces. Firewall templates come with some protection rules already configured. **Permissions and scopes** To call this operation, you need permissions, based on the model you're using: - **OAuth scopes**. Your user needs these scopes assigned. [Learn more](https://techdocs.akamai.com/linode-api/reference/get-started#oauth). - Scopes: `firewall:read_only` **CLI** ```shell linode-cli firewalls templates-list ``` [Learn more](https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli) - [Get a firewall template](https://techdocs.akamai.com/linode-api/reference/get-firewall-template.md): Gets a `vpc` or `public` firewall template you can use with Linode VPC and public interfaces. Firewall templates come with some protection rules already configured. The public interface's firewall template allows for login with SSH, and regular networking control data. You should further strengthen these rules by limiting the allowed IPv4 and IPv6 ranges. The VPC interface's firewall template allows for login with SSH, regular networking control data, and inbound traffic from the VPC address space. You should further strengthen these rules by limiting the allowed IPv4 and IPv6 ranges. **Permissions and scopes** To call this operation, you need permissions, based on the model you're using: - **OAuth scopes**. Your user needs these scopes assigned. [Learn more](https://techdocs.akamai.com/linode-api/reference/get-started#oauth). - Scopes: `firewall:read_only` **CLI** ```shell linode-cli firewalls template-view vpc ``` [Learn more](https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli) - [Create a firewall device](https://techdocs.akamai.com/linode-api/reference/post-firewall-device.md): Creates a firewall device, which assigns a firewall to a service (referred to as the device's `entity`) and applies the firewall's rules to the device. - Currently, devices with `linode`, `linode_interface`, and `nodebalancer` entity types are accepted. - The `linode` type is not allowed for Linodes using Linode interfaces. - The `linode_interface` type is not allowed for legacy config interfaces. For VPC and public legacy config profile interfaces, the firewall is applied through the `linode` device. - The `linode_interface` type only supports regular Linode interfaces, (public or VPC Linode interfaces). - Firewalls only apply to inbound TCP traffic to NodeBalancers. - A firewall can be assigned to multiple services at a time. - A service can have one assigned firewall at a time. - Assigned Linodes must not have any ongoing live migrations. - A `firewall_device_add` event is generated when the firewall device is added successfully. **Permissions and scopes** To call this operation, you need permissions, based on the model you're using: - **Identity and access permissions**. Your user needs a role with these permissions. [Learn more](https://techdocs.akamai.com/cloud-computing/docs/identity-access-cm-available-roles). - Permissions: `create_firewall_device` - **OAuth scopes**. Your user needs these scopes assigned. [Learn more](https://techdocs.akamai.com/linode-api/reference/get-started#oauth). - Scopes: `firewall:read_write` **CLI** ```shell linode-cli firewalls device-create 123 \ --id 456 \ --type "linode" ``` [Learn more](https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli) - [List firewall devices](https://techdocs.akamai.com/linode-api/reference/get-firewall-devices.md): Returns a paginated list of a firewall's devices. A firewall device assigns a firewall to a service (referred to as the device's `entity`). **Permissions and scopes** To call this operation, you need permissions, based on the model you're using: - **Identity and access permissions**. Your user needs a role with these permissions. [Learn more](https://techdocs.akamai.com/cloud-computing/docs/identity-access-cm-available-roles). - Permissions: `view_firewall` - **OAuth scopes**. Your user needs these scopes assigned. [Learn more](https://techdocs.akamai.com/linode-api/reference/get-started#oauth). - Scopes: `firewall:read_only` **CLI** ```shell linode-cli firewalls devices-list 123 ``` [Learn more](https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli) - [Get a firewall device](https://techdocs.akamai.com/linode-api/reference/get-firewall-device.md): Returns information for a Firewall Device, which assigns a Firewall to a service (referred to as the Device's `entity`). **Permissions and scopes** To call this operation, you need permissions, based on the model you're using: - **Identity and access permissions**. Your user needs a role with these permissions. [Learn more](https://techdocs.akamai.com/cloud-computing/docs/identity-access-cm-available-roles). - Permissions: `view_firewall_device` - **OAuth scopes**. Your user needs these scopes assigned. [Learn more](https://techdocs.akamai.com/linode-api/reference/get-started#oauth). - Scopes: `firewall:read_only` **CLI** ```shell linode-cli firewalls device-view \ 123 456 ``` [Learn more](https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli) - [Delete a firewall device](https://techdocs.akamai.com/linode-api/reference/delete-firewall-device.md): Removes a Firewall Device, which removes a Firewall from the service it was assigned to by the Device. This removes all of the Firewall's Rules from the service. If any other Firewalls have been assigned to the service, then those Rules remain in effect. - Assigned Linodes must not have any ongoing live migrations. - A `firewall_device_remove` Event is generated when the Firewall Device is removed successfully. **Permissions and scopes** To call this operation, you need permissions, based on the model you're using: - **Identity and access permissions**. Your user needs a role with these permissions. [Learn more](https://techdocs.akamai.com/cloud-computing/docs/identity-access-cm-available-roles). - Permissions: `delete_firewall_device` - **OAuth scopes**. Your user needs these scopes assigned. [Learn more](https://techdocs.akamai.com/linode-api/reference/get-started#oauth). - Scopes: `firewall:read_write` **CLI** ```shell linode-cli firewalls device-delete 123 456 ``` [Learn more](https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli) - [Allocate an IP address](https://techdocs.akamai.com/linode-api/reference/post-allocate-ip.md): To manage your network configuration, you can allocate ephemeral or reserved IP addresses depending on your need for temporary or permanent connectivity. The Linode must be configured to support additional addresses. Before you allocate, [open a support ticket](ref:post-ticket) to request additional addresses. Ephemeral IPv4 addresses are temporary and tied directly to a specific resource rather than your account. They're typically recycled and returned to the pool once the associated resource is deleted. Reserved IPs are static, permanent addresses ideal for services requiring a consistent entry point. A reserved IP is permanently locked to the specific region where it was created. You can create a reserved IP independently of a Linode, allowing it to exist on your account with or without an active assignment, but it can only be assigned to resources within that same region. Charges apply as soon as a reserved IP is added to your account, regardless of whether it's assigned to a resource. > 📘 > > You can run this operation for Linodes with legacy configuration interfaces. You can't use it for Linodes with Linode interfaces. To allocate an IP for a Linode with Linode interfaces, use the [Add a Linode interface](https://techdocs.akamai.com/linode-api/reference/post-linode-interface) operation. **Permissions and scopes** To call this operation, you need permissions, based on the model you're using: - **OAuth scopes**. Your user needs these scopes assigned. [Learn more](https://techdocs.akamai.com/linode-api/reference/get-started#oauth). - Scopes: `ips:read_write` **CLI** *CLI example - Ephemeral IP* ```shell linode-cli networking ip-add \ --type ipv4 \ --public false \ --linode_id 123 ``` *CLI example - Reserved IP* ```shell linode-cli networking ip-add \ --type ipv4 \ --public true \ --linode_id 123 \ --reserved true \ --region us-east ``` [Learn more](https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli) - [List IP addresses](https://techdocs.akamai.com/linode-api/reference/get-ips.md): Returns a paginated list of public IP addresses associated with your account. Private addresses are excluded. > 👍 > > if your application frequently accesses this operation and doesn't require IPv6 RDNS data, you can use the `skip_ipv6_rdns` query string to improve performance. **Permissions and scopes** To call this operation, you need permissions, based on the model you're using: - **OAuth scopes**. Your user needs these scopes assigned. [Learn more](https://techdocs.akamai.com/linode-api/reference/get-started#oauth). - Scopes: `ips:read_only` **CLI** ```shell linode-cli networking ips-list ``` [Learn more](https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli) - [Assign IP addresses](https://techdocs.akamai.com/linode-api/reference/post-assign-ips.md): Assigns a set of IPv4 addresses and IPv6 ranges to Linodes within a single region. This operation lets you swap, shuffle, or reorganize IP addresses among your Linodes, and assign reserved IPs that aren't currently assigned to specific Linode instances. The following restrictions apply: - All addresses must be an IPv4 address or an IPv6 range you can access in the specified region. This includes unassigned reserved IP addresses belonging to your account. - If you specify a reserved IP, it must be reserved in your account. Assigning an unassigned reserved IP moves the IP from your account's general pool and becomes an assigned resource tied to a specific Linode interface. Using a reserved IP that you don't own results in a 400 error. - You can't swap an assigned reserved IP with a newly created ephemeral IP using this operation. To convert or toggle the status of an IP, use the [Update an IP address's RDNS and reserved setting](ref:put-ip) operation. - All Linodes need to have at least one public IPv4 address assigned. - Linodes that use Linode interfaces can't be assigned a private IPv4 address. - Linodes that use configuration profile interfaces may have a maximum of one assigned private IPv4 address. - Linodes are restricted to one assigned IPv6 range. - Shared IP addresses can't be swapped between Linodes. [Open a support ticket](ref:post-ticket) to request additional IPv4 addresses or IPv6 ranges beyond standard account limits. > 📘 > > Removing an IP address that has been set as a Managed Linode's `ssh.ip` causes the Managed Linode's SSH access settings to reset to their default values. To view and configure Managed Linode SSH settings, use the following operations: - [Get a Linode's managed settings](ref:get-managed-linode-setting) - [Update a Linode's managed settings](ref:put-managed-linode-setting) **Permissions and scopes** To call this operation, you need permissions, based on the model you're using: - **OAuth scopes**. Your user needs these scopes assigned. [Learn more](https://techdocs.akamai.com/linode-api/reference/get-started#oauth). - Scopes: `ips:read_write, linodes:read_write` **CLI** ```shell linode-cli networking ip-assign \ --region us-east \ --assignments.address 192.0.2.1 \ --assignments.linode_id 123 \ --assignments.address 2001:db8:3c4d:15::/64 \ --assignments.linode_id 234 ``` [Learn more](https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli) - [Share IP addresses](https://techdocs.akamai.com/linode-api/reference/post-share-ips.md): Configure shared IPs. IP sharing allows IP address reassignment (also referred to as IP failover) from one Linode to another if the primary Linode becomes unresponsive. This means that requests to the primary Linode's IP address can be automatically rerouted to secondary Linodes at the configured shared IP addresses. IP failover requires configuration of a [BGP based failover service](https://techdocs.akamai.com/cloud-computing/docs/configure-failover-on-a-compute-instance) within the internal system of the primary Linode. > 📘 > > A public IPv4 address can't be shared if it's configured for a 1:1 NAT on a legacy configuration profile VPC interface or on a Linode VPC interface. **Permissions and scopes** To call this operation, you need permissions, based on the model you're using: - **OAuth scopes**. Your user needs these scopes assigned. [Learn more](https://techdocs.akamai.com/linode-api/reference/get-started#oauth). - Scopes: `ips:read_write, linodes:read_write` **CLI** ```shell linode-cli networking ip-share \ --linode_id 123 \ --ips 192.0.2.1 \ --ips 2001:db8:3c4d:15:: ``` [Learn more](https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli) - [Get an IP address](https://techdocs.akamai.com/linode-api/reference/get-ip.md): Returns information about a single IP Address on your Account. **Permissions and scopes** To call this operation, you need permissions, based on the model you're using: - **OAuth scopes**. Your user needs these scopes assigned. [Learn more](https://techdocs.akamai.com/linode-api/reference/get-started#oauth). - Scopes: `ips:read_only` **CLI** ```shell linode-cli networking ip-view 97.107.143.141 ``` [Learn more](https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli) - [Update an IP address](https://techdocs.akamai.com/linode-api/reference/put-ip.md): Updates the configuration of an existing IP address. Use this operation to set Reverse DNS (RDNS) and to toggle the `reserved` status of an IPv4 address. You can update both the `reserved` status and the `rdns` field in a single request, if the IP is assigned to a Linode. __RDNS__: - Forward DNS must already be set up for reverse DNS to be applied. - If you set the `rdns` to `null` for public IPv4 addresses, it resets to the default `ip.linodeusercontent.com` RDNS value. - You can't set RDNS on an unassigned reserved IP. The IP must be assigned to a Linode to update its RDNS record. __Reserved IP__: - Setting `reserved` to `true` on an ephemeral IP converts it to a reserved IP. - Setting `reserved` to `false` on a reserved IP converts it to an ephemeral IP. If you convert an unassigned reserved IP to ephemeral, the IP is immediately released from your account. Unreserving this IP removes it from your reserved list and makes it unavailable to assign. This action can't be undone. **Permissions and scopes** To call this operation, you need permissions, based on the model you're using: - **OAuth scopes**. Your user needs these scopes assigned. [Learn more](https://techdocs.akamai.com/linode-api/reference/get-started#oauth). - Scopes: `ips:read_write` **CLI** ```shell linode-cli networking ip-update \ 203.0.113.1 \ --rdns "test.example.org" \ --reserved true ``` [Learn more](https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli) - [Assign IPv4s to Linodes](https://techdocs.akamai.com/linode-api/reference/post-assign-ipv4s.md): This operation is equivalent to [Assign IP addresses](ref:post-assign-ips). Assign multiple IPv4 addresses and/or IPv6 ranges to multiple Linodes in one Region. This allows swapping, shuffling, or otherwise reorganizing IPs to your Linodes. The following restrictions apply: - All Linodes involved must have at least one public IPv4 address after assignment. - For Linode interfaces, the Linode needs to have a public interface, and the address it receives can't be a private IPv4 address. - Linodes may have no more than one assigned private IPv4 address. - Linodes may have no more than one assigned IPv6 range. [Open a support ticket](ref:post-ticket) to request additional IPv4 addresses or IPv6 ranges beyond standard account limits. > 📘 > > Removing an IP address that has been set as a Managed Linode's `ssh.ip` causes the Managed Linode's SSH access settings to reset to their default values. To view and configure Managed Linode SSH settings, use the following operations: - [Get a Linode's managed settings](ref:get-managed-linode-setting) - [Update a Linode's managed settings](ref:put-managed-linode-setting) **Permissions and scopes** To call this operation, you need permissions, based on the model you're using: - **OAuth scopes**. Your user needs these scopes assigned. [Learn more](https://techdocs.akamai.com/linode-api/reference/get-started#oauth). - Scopes: `ips:read_write, linodes:read_write` - [Configure IPv4 sharing](https://techdocs.akamai.com/linode-api/reference/post-share-ipv4s.md): This operation is equivalent to [Share IP addresses](ref:post-share-ips). Configure shared IPs. IP sharing allows IP address reassignment (also referred to as IP failover) from one Linode to another if the primary Linode becomes unresponsive. This means that requests to the primary Linode's IP address can be automatically rerouted to secondary Linodes at the configured shared IP addresses. IP failover requires configuration of a [BGP based failover service](https://techdocs.akamai.com/cloud-computing/docs/configure-failover-on-a-compute-instance) within the internal system of the primary Linode. > 📘 > > A public IPv4 address can't be shared if it's configured for a 1:1 NAT on a legacy configuration profile VPC interface or on a Linode VPC interface. **Permissions and scopes** To call this operation, you need permissions, based on the model you're using: - **OAuth scopes**. Your user needs these scopes assigned. [Learn more](https://techdocs.akamai.com/linode-api/reference/get-started#oauth). - Scopes: `ips:read_write, linodes:read_write` - [List IPv6 pools](https://techdocs.akamai.com/linode-api/reference/get-ipv6-pools.md): Displays the IPv6 pools on your Account. A pool of IPv6 addresses are routed to all of your Linodes in a single [region](ref:get-regions). Any Linode on your Account may bring up any address in this pool at any time, with no external configuration required. **Permissions and scopes** To call this operation, you need permissions, based on the model you're using: - **OAuth scopes**. Your user needs these scopes assigned. [Learn more](https://techdocs.akamai.com/linode-api/reference/get-started#oauth). - Scopes: `ips:read_only` **CLI** ```shell linode-cli networking v6-pools ``` [Learn more](https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli) - [Create an IPv6 range](https://techdocs.akamai.com/linode-api/reference/post-ipv6-range.md): Creates an IPv6 Range and assigns it based on the provided Linode or route target IPv6 SLAAC address. See the `ipv6` property when running the [Get a Linode](ref:get-linode-instance) operation to view a Linode's IPv6 SLAAC address. - Either `linode_id` or `route_target` is required in a request. - `linode_id` and `route_target` are mutually exclusive. Submitting values for both properties in a request results in an error. - Upon a successful request, an IPv6 range is created in the [region](ref:get-regions) that corresponds to the provided `linode_id` or `route_target`. - Your Linode is responsible for routing individual addresses in the range, or handling traffic for all the addresses in the range. - Run the [Assign IP addresses](ref:post-assign-ips) operation to re-assign IPv6 Ranges to your Linodes. > 📘 > > - A Linode can only have one IPv6 range targeting its SLAAC address. > - An account can only have one IPv6 range in each [region](ref:get-regions). > - [Open a support ticket](ref:post-ticket) to request expansion of these restrictions. **Permissions and scopes** To call this operation, you need permissions, based on the model you're using: - **OAuth scopes**. Your user needs these scopes assigned. [Learn more](https://techdocs.akamai.com/linode-api/reference/get-started#oauth). - Scopes: `ips:read_write, linodes:read_write` **CLI** ```shell linode-cli networking v6-range-create \ --linode_id 123 \ --prefix_length 64 ``` [Learn more](https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli) - [List IPv6 ranges](https://techdocs.akamai.com/linode-api/reference/get-ipv6-ranges.md): Displays the IPv6 ranges on your Account. - An IPv6 range is a `/64` or `/56` block of IPv6 addresses routed to a single Linode in a given [region](ref:get-regions). - Your Linode is responsible for routing individual addresses in the range, or handling traffic for all the addresses in the range. - Run the [Create an IPv6 range](ref:post-ipv6-range) operation to add a `/64` or `/56` block of IPv6 addresses to your account. **Permissions and scopes** To call this operation, you need permissions, based on the model you're using: - **OAuth scopes**. Your user needs these scopes assigned. [Learn more](https://techdocs.akamai.com/linode-api/reference/get-started#oauth). - Scopes: `ips:read_only` **CLI** ```shell linode-cli networking v6-ranges ``` [Learn more](https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli) - [Get an IPv6 range](https://techdocs.akamai.com/linode-api/reference/get-ipv6-range.md): View IPv6 range information. **Permissions and scopes** To call this operation, you need permissions, based on the model you're using: - **OAuth scopes**. Your user needs these scopes assigned. [Learn more](https://techdocs.akamai.com/linode-api/reference/get-started#oauth). - Scopes: `ips:read` **CLI** ```shell linode-cli networking v6-range-view 2001:0db8:: ``` [Learn more](https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli) - [Delete an IPv6 range](https://techdocs.akamai.com/linode-api/reference/delete-ipv6-range.md): Removes this IPv6 range from your account and disconnects the range from any assigned Linodes. > 📘 > > You can't delete shared IPv6 ranges. Contact Customer Support for assistance. **Permissions and scopes** To call this operation, you need permissions, based on the model you're using: - **OAuth scopes**. Your user needs these scopes assigned. [Learn more](https://techdocs.akamai.com/linode-api/reference/get-started#oauth). - Scopes: `ips:read_write` **CLI** ```shell linode-cli networking v6-range-delete 2001:0db8:: ``` [Learn more](https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli) - [Reserve a public IPv4 address](https://techdocs.akamai.com/linode-api/reference/post-reserved-ip.md): Reserve a public IPv4 address within a specific region for future assignment to a resource. Because Reserved IPs are tied to a specific datacenter's network infrastructure, they can't be moved across regions. However, they provide a persistent public entry point for your cloud infrastructure inside that region, independent of the underlying resource. Unlike ephemeral IPs that are recycled upon deletion, a reserved IP remains in your account until manually released. Benefits: - Rebuild or migrate Linodes and NodeBalancers without changing your public-facing IP. - Eliminates the need to update allowlists, firewall rules, automation scripts, or DNS records during deployments. - Maintain ownership of the address during failovers or maintenance windows when it may be temporarily unassigned. - Billed at a flat monthly rate per IP, regardless of assignment status. Unreserving an IP stops billing immediately and returns the address to the general pool, where it can't be recovered. **Permissions and scopes** To call this operation, you need permissions, based on the model you're using: - **OAuth scopes**. Your user needs these scopes assigned. [Learn more](https://techdocs.akamai.com/linode-api/reference/get-started#oauth). - Scopes: `ips:read_write` **CLI** ```shell linode-cli networking reserved-ip-add \ --region us-east \ --tags NB1,Linode1 ``` [Learn more](https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli) - [List reserved IP addresses](https://techdocs.akamai.com/linode-api/reference/get-reserved-ips.md): Returns a paginated list of reserved IP addresses on your account. **Permissions and scopes** To call this operation, you need permissions, based on the model you're using: - **OAuth scopes**. Your user needs these scopes assigned. [Learn more](https://techdocs.akamai.com/linode-api/reference/get-started#oauth). - Scopes: `ips:read_only` **CLI** ```shell linode-cli networking reserved-ips-list ``` [Learn more](https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli) - [Get reserved IP pricing](https://techdocs.akamai.com/linode-api/reference/get-reserved-ip-types.md): Returns pricing information for reserved IPs. **Permissions and scopes** To call this operation, you need permissions, based on the model you're using: - **OAuth scopes**. Your user needs these scopes assigned. [Learn more](https://techdocs.akamai.com/linode-api/reference/get-started#oauth). - Scopes: `reserved-ips:read_only` **CLI** ```shell linode-cli networking reserved-ip-types-list ``` [Learn more](https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli) - [Get a reserved IP address](https://techdocs.akamai.com/linode-api/reference/get-reserved-ip.md): Returns information about a reserved IP address on your account. **Permissions and scopes** To call this operation, you need permissions, based on the model you're using: - **OAuth scopes**. Your user needs these scopes assigned. [Learn more](https://techdocs.akamai.com/linode-api/reference/get-started#oauth). - Scopes: `reserved-ips:read_only` **CLI** ```shell linode-cli networking reserved-ip-view 192.107.143.141 ``` [Learn more](https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli) - [Update reserved IP address tags](https://techdocs.akamai.com/linode-api/reference/put-reserved-ip.md): Replaces the current tags for the reserved IP address with the new set provided. **Permissions and scopes** To call this operation, you need permissions, based on the model you're using: - **OAuth scopes**. Your user needs these scopes assigned. [Learn more](https://techdocs.akamai.com/linode-api/reference/get-started#oauth). - Scopes: `reserved-ips:read_write` **CLI** ```shell linode-cli networking reserved-ip-update \ 192.107.143.141 \ --tags NB2, Linode2 ``` [Learn more](https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli) - [Unreserve an IP address](https://techdocs.akamai.com/linode-api/reference/delete-reserved-ip.md): Permanently removes the reserved IP address from your account and stops all associated charges. Once unreserved, the IP address can't be recovered. **Permissions and scopes** To call this operation, you need permissions, based on the model you're using: - **OAuth scopes**. Your user needs these scopes assigned. [Learn more](https://techdocs.akamai.com/linode-api/reference/get-started#oauth). - Scopes: `reserved-ips:read_write` **CLI** ```shell linode-cli networking reserved-ip-delete \ 192.107.143.141 ``` [Learn more](https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli) - [List VLANs](https://techdocs.akamai.com/linode-api/reference/get-vlans.md): Returns a list of all Virtual Local Area Networks (VLANs) on your account. VLANs provide a mechanism for secure communication between two or more Linodes that are assigned to the same VLAN, and are both within the same Layer 2 broadcast domain. For legacy configuration profile interfaces, you can use the following operations to create, attach, detach, and delete VLANs on a Linode: - [Create a Linode](ref:post-linode-instance) - [Create a config profile](ref:post-add-linode-config) - [Update a config profile](ref:put-linode-config) - [Update](ref:put-linode-config) the active Configuration Profile to remove the VLAN Interface, then [reboot](ref:post-reboot-linode-instance) the Linode. - [Create a config profile](ref:post-add-linode-config) without the VLAN Interface, then [reboot](ref:post-reboot-linode-instance) the Linode into the new Configuration Profile. - [Delete](ref:delete-linode-instance) the Linode. For Linode interfaces, you can use the following operations to create, attach, detach, and delete VLANs on a Linode: - [Create a Linode](ref:post-linode-instance) - [Add a Linode interface](ref:post-linode-interface) - [Update a Linode interface](put-linode-interface-settings) - [Delete a Linode interface](ref:delete-linode-interface) from a Linode. > 📘 > > - Only Next Generation Network (NGN) data centers support VLANs. Run the [List regions](ref:get-regions) operation to view the capabilities of data center regions. If a VLAN is attached to your Linode and you attempt to migrate or clone it to a non-NGN data center, the migration or cloning won't initiate. If a Linode cannot be migrated because of an incompatibility, you will be prompted to select a different data center or contact support. > > - See the [VLANs Overview](https://www.linode.com/docs/products/networking/vlans/#technical-specifications) to view additional specifications and limitations. **Permissions and scopes** To call this operation, you need permissions, based on the model you're using: - **OAuth scopes**. Your user needs these scopes assigned. [Learn more](https://techdocs.akamai.com/linode-api/reference/get-started#oauth). - Scopes: `linodes:read_only` **CLI** ```shell linode-cli vlans list ``` [Learn more](https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli) - [Delete a VLAN](https://techdocs.akamai.com/linode-api/reference/delete-vlan.md): This operation deletes a legacy configuration profile VLAN interface. To delete a Linode interface VLAN, use the [Delete a Linode interface](ref:delete-linode-interface) operation. You can't delete a VLAN if it's still attached to a Linode. There are a few ways to detach it: - [Update](ref:put-linode-config) the active configuration profile to remove the VLAN interface, then [reboot](ref:post-reboot-linode-instance) the Linode. - [Create a config profile](ref:post-add-linode-config) without the VLAN interface, then [reboot](ref:post-reboot-linode-instance) the Linode into the new configuration profile. - [Delete](ref:delete-linode-instance) the Linode. A successful request triggers a `vlan_delete` event. > 📘 > > VLANs without any attached Linodes are periodically cleaned up by the system. **Permissions and scopes** To call this operation, you need permissions, based on the model you're using: - **OAuth scopes**. Your user needs these scopes assigned. [Learn more](https://techdocs.akamai.com/linode-api/reference/get-started#oauth). - Scopes: `linodes:read_write` **CLI** ```shell linode-cli vlans delete $regionId $label ``` [Learn more](https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli) - [Create a NodeBalancer](https://techdocs.akamai.com/linode-api/reference/post-node-balancer.md): Creates a NodeBalancer in the requested Region. Only available in [regions](ref:get-regions) with "NodeBalancers" in their `capabilities`. NodeBalancers require a port config with at least one backend node to start serving requests. When using the Linode CLI to create a NodeBalancer, first create a NodeBalancer without any configs. Then, create configs and nodes for that NodeBalancer with the respective [Create a config](ref:post-node-balancer-config) and [Create a node](ref:post-node-balancer-node) operations. After creating a NodeBalancer, account administrators can add a lock to prevent accidental NodeBalancer deletion by using the [Create a resource lock](ref:post-resource-lock) operation. **Permissions and scopes** To call this operation, you need permissions, based on the model you're using: - **Identity and access permissions**. Your user needs a role with these permissions. [Learn more](https://techdocs.akamai.com/cloud-computing/docs/identity-access-cm-available-roles). - Permissions: `create_nodebalancer` - **OAuth scopes**. Your user needs these scopes assigned. [Learn more](https://techdocs.akamai.com/linode-api/reference/get-started#oauth). - Scopes: `nodebalancers:read_write` **CLI** ```shell linode-cli nodebalancers create \ --region us-east \ --label balancer12345 \ --ipv4 "192.0.2.141" \ --client_conn_throttle 0 ``` [Learn more](https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli) - [List NodeBalancers](https://techdocs.akamai.com/linode-api/reference/get-node-balancers.md): Returns a paginated list of NodeBalancers you have access to. **Permissions and scopes** To call this operation, you need permissions, based on the model you're using: - **Identity and access permissions**. Your user needs a role with these permissions. [Learn more](https://techdocs.akamai.com/cloud-computing/docs/identity-access-cm-available-roles). - Permissions: `view_nodebalancer` - **OAuth scopes**. Your user needs these scopes assigned. [Learn more](https://techdocs.akamai.com/linode-api/reference/get-started#oauth). - Scopes: `nodebalancers:read_only` **CLI** ```shell linode-cli nodebalancers list ``` [Learn more](https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli) - [Get a NodeBalancer](https://techdocs.akamai.com/linode-api/reference/get-node-balancer.md): Returns a single NodeBalancer you can access. Run the [List VPC configurations](ref:get-node-balancer-vpcs) operation to get the NodeBalancer's VPC configuration. **Permissions and scopes** To call this operation, you need permissions, based on the model you're using: - **Identity and access permissions**. Your user needs a role with these permissions. [Learn more](https://techdocs.akamai.com/cloud-computing/docs/identity-access-cm-available-roles). - Permissions: `view_nodebalancer` - **OAuth scopes**. Your user needs these scopes assigned. [Learn more](https://techdocs.akamai.com/linode-api/reference/get-started#oauth). - Scopes: `nodebalancers:read_only` **CLI** ```shell linode-cli nodebalancers view 12345 ``` [Learn more](https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli) - [Update a NodeBalancer](https://techdocs.akamai.com/linode-api/reference/put-node-balancer.md): Updates information about a NodeBalancer you can access. > 🚧 > > You can configure UDP on the same NodeBalancer that also uses TCP, HTTP, or HTTPS, but only when managing it through the API. If UDP is configured and you make changes to the TCP, HTTP or HTTPS settings in Cloud Manager, the existing UDP configuration will be overwritten. This is because Cloud Manager doesn't currently support UDP. **Permissions and scopes** To call this operation, you need permissions, based on the model you're using: - **Identity and access permissions**. Your user needs a role with these permissions. [Learn more](https://techdocs.akamai.com/cloud-computing/docs/identity-access-cm-available-roles). - Permissions: `update_nodebalancer` - **OAuth scopes**. Your user needs these scopes assigned. [Learn more](https://techdocs.akamai.com/linode-api/reference/get-started#oauth). - Scopes: `nodebalancers:read_write` **CLI** ```shell linode-cli nodebalancers update 12345 \ --label balancer12345 \ --client_conn_throttle 0 ``` [Learn more](https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli) - [Delete a NodeBalancer](https://techdocs.akamai.com/linode-api/reference/delete-node-balancer.md): Deletes a NodeBalancer. __This is a destructive action and cannot be undone.__ A NodeBalancer can't be deleted if it has a `cannot_delete` or a `cannot_delete_with_subresources` lock. Only account administrators can remove locks using the [Delete a resource lock](ref:delete-resource-lock) operation. Deleting a NodeBalancer also deletes all associated configurations and nodes. However, the backend servers represented by these nodes are not changed or removed. When you delete a NodeBalancer, you lose access to the ephemeral IP addresses assigned to it. When a NodeBalancer is deleted, any assigned reserved IP remains on your account in an unassigned state, preserving the address for future use. Conversely, ephemeral IPs are released and can't be recovered. **Permissions and scopes** To call this operation, you need permissions, based on the model you're using: - **Identity and access permissions**. Your user needs a role with these permissions. [Learn more](https://techdocs.akamai.com/cloud-computing/docs/identity-access-cm-available-roles). - Permissions: `delete_nodebalancer` - **OAuth scopes**. Your user needs these scopes assigned. [Learn more](https://techdocs.akamai.com/linode-api/reference/get-started#oauth). - Scopes: `nodebalancers:read_write` **CLI** ```shell linode-cli nodebalancers delete 12345 ``` [Learn more](https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli) - [List NodeBalancer types](https://techdocs.akamai.com/linode-api/reference/get-node-balancer-types.md): Returns NodeBalancer types and prices, including any region-specific rates. **CLI** ```shell linode-cli nodebalancers types ``` [Learn more](https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli) - [Create a config](https://techdocs.akamai.com/linode-api/reference/post-node-balancer-config.md): Creates a NodeBalancer configuration, which allows the NodeBalancer to accept traffic on a new port. You will need to add NodeBalancer nodes to the new configuration before it can actually serve requests. > 🚧 > > You can configure UDP on the same NodeBalancer that also uses TCP, HTTP, or HTTPS, but only when managing it through the API. If UDP is configured and you make changes to the TCP, HTTP or HTTPS settings in Cloud Manager, the existing UDP configuration will be overwritten. This is because Cloud Manager doesn't currently support UDP. After creating a NodeBalancer configuration, account administrators can run the [Create a resource lock](ref:post-resource-lock) operation to prevent accidentally deleting configurations. **Permissions and scopes** To call this operation, you need permissions, based on the model you're using: - **Identity and access permissions**. Your user needs a role with these permissions. [Learn more](https://techdocs.akamai.com/cloud-computing/docs/identity-access-cm-available-roles). - Permissions: `create_nodebalancer_config` - **OAuth scopes**. Your user needs these scopes assigned. [Learn more](https://techdocs.akamai.com/linode-api/reference/get-started#oauth). - Scopes: `nodebalancers:read_write` **CLI** *HTTPS* ```shell linode-cli nodebalancers config-create 12345 \ --port 443 \ --protocol https \ --algorithm roundrobin \ --stickiness http_cookie \ --check http_body \ --check_interval 90 \ --check_timeout 10 \ --check_attempts 3 \ --check_path "/test" \ --check_body "it works" \ --check_passive true \ --proxy_protocol "none" \ --ssl_cert "-----BEGIN CERTIFICATE----- CERTIFICATE_INFORMATION -----END CERTIFICATE-----" \ --ssl_key "-----BEGIN PRIVATE KEY----- PRIVATE_KEY_INFORMATION -----END PRIVATE KEY-----" \ --cipher_suite recommended ``` *UDP* ```shell linode-cli nodebalancers config-create 12345 \ --port 80 \ --protocol udp \ --algorithm ring_hash \ --stickiness session \ --check http_body \ --check_interval 90 \ --check_timeout 10 \ --check_attempts 3 \ --check_path "/test" \ --check_body "it works" \ --udp_check_port 80 ``` *TCP* ```shell linode-cli nodebalancers config-create 12345 \ --port 80 \ --protocol tcp \ --algorithm roundrobin \ --stickiness none \ --check http_body \ --check_interval 90 \ --check_timeout 10 \ --check_attempts 3 \ --check_path "/test" \ --check_body "it works" \ --proxy_protocol "v2" ``` *HTTP* ```shell linode-cli nodebalancers config-create 12345 \ --port 440 \ --protocol http \ --algorithm roundrobin \ --stickiness http_cookie \ --check http_body \ --check_interval 90 \ --check_timeout 10 \ --check_attempts 3 \ --check_path "/test" \ --check_body "it works" ``` [Learn more](https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli) - [List configs](https://techdocs.akamai.com/linode-api/reference/get-node-balancer-configs.md): Returns a paginated list of NodeBalancer Configs associated with this NodeBalancer. NodeBalancer Configs represent individual ports that this NodeBalancer will accept traffic on, one Config per port. For example, if you wanted to accept standard HTTP traffic, you would need a Config listening on port 80. **Permissions and scopes** To call this operation, you need permissions, based on the model you're using: - **Identity and access permissions**. Your user needs a role with these permissions. [Learn more](https://techdocs.akamai.com/cloud-computing/docs/identity-access-cm-available-roles). - Permissions: `view_nodebalancer_config` - **OAuth scopes**. Your user needs these scopes assigned. [Learn more](https://techdocs.akamai.com/linode-api/reference/get-started#oauth). - Scopes: `nodebalancers:read_only` **CLI** ```shell linode-cli nodebalancers configs-list 12345 ``` [Learn more](https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli) - [Get a config](https://techdocs.akamai.com/linode-api/reference/get-node-balancer-config.md): Returns configuration information for a single port of this NodeBalancer. **Permissions and scopes** To call this operation, you need permissions, based on the model you're using: - **Identity and access permissions**. Your user needs a role with these permissions. [Learn more](https://techdocs.akamai.com/cloud-computing/docs/identity-access-cm-available-roles). - Permissions: `view_nodebalancer_config` - **OAuth scopes**. Your user needs these scopes assigned. [Learn more](https://techdocs.akamai.com/linode-api/reference/get-started#oauth). - Scopes: `nodebalancers:read_only` **CLI** ```shell linode-cli nodebalancers config-view \ 12345 4567 ``` [Learn more](https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli) - [Update a config](https://techdocs.akamai.com/linode-api/reference/put-node-balancer-config.md): Updates the configuration for a single port on a NodeBalancer. > 🚧 > > You can configure UDP on the same NodeBalancer that also uses TCP, HTTP, or HTTPS, but only when managing it through the API. If UDP is configured and you make changes to the TCP, HTTP or HTTPS settings in Cloud Manager, the existing UDP configuration will be overwritten. This is because Cloud Manager doesn't currently support UDP. **Permissions and scopes** To call this operation, you need permissions, based on the model you're using: - **Identity and access permissions**. Your user needs a role with these permissions. [Learn more](https://techdocs.akamai.com/cloud-computing/docs/identity-access-cm-available-roles). - Permissions: `update_nodebalancer_config` - **OAuth scopes**. Your user needs these scopes assigned. [Learn more](https://techdocs.akamai.com/linode-api/reference/get-started#oauth). - Scopes: `nodebalancers:read_write` **CLI** *HTTPS* ```shell linode-cli nodebalancers config-update \ 12345 4567 \ --port 443 \ --protocol https \ --algorithm roundrobin \ --stickiness http_cookie \ --check http_body \ --check_interval 90 \ --check_timeout 10 \ --check_attempts 3 \ --check_path "/test" \ --check_body "it works" \ --check_passive true \ --proxy_protocol "none" \ --ssl_cert "-----BEGIN CERTIFICATE----- CERTIFICATE_INFORMATION -----END CERTIFICATE-----" \ --ssl_key "-----BEGIN PRIVATE KEY----- PRIVATE_KEY_INFORMATION -----END PRIVATE KEY-----" \ --cipher_suite recommended ``` *UDP* ```shell linode-cli nodebalancers config-update \ 12345 4567 \ --port 80 \ --protocol udp \ --algorithm ring_hash \ --stickiness session \ --check http_body \ --check_interval 90 \ --check_timeout 10 \ --check_attempts 3 \ --check_path "/test" \ --check_body "it works" \ --udp_check_port 80 ``` *TCP* ```shell linode-cli nodebalancers config-update \ 12345 4567 \ --port 80 \ --protocol tcp \ --algorithm roundrobin \ --stickiness none \ --stickiness http_cookie \ --check http_body \ --check_interval 90 \ --check_timeout 10 \ --check_attempts 3 \ --check_path "/test" \ --check_body "it works" \ --proxy_protocol "v2" ``` *HTTP* ```shell linode-cli nodebalancers config-update \ 12345 4567 \ --port 440 \ --protocol http \ --algorithm roundrobin \ --stickiness http_cookie \ --check http_body \ --check_interval 90 \ --check_timeout 10 \ --check_attempts 3 \ --check_path "/test" \ --check_body "it works" ``` [Learn more](https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli) - [Delete a config](https://techdocs.akamai.com/linode-api/reference/delete-node-balancer-config.md): Deletes the configuration for a port of this NodeBalancer. __This can't be undone.__ A NodeBalancer configuration can't be deleted if it has a `cannot_delete_with_subresources` lock. Only account administrators can remove locks using the [Delete a resource lock](ref:delete-resource-lock) operation. Once completed, this NodeBalancer will no longer respond to requests on the given port. This also deletes all associated NodeBalancerNodes, but the Linodes they were routing traffic to will be unchanged and will not be removed. **Permissions and scopes** To call this operation, you need permissions, based on the model you're using: - **Identity and access permissions**. Your user needs a role with these permissions. [Learn more](https://techdocs.akamai.com/cloud-computing/docs/identity-access-cm-available-roles). - Permissions: `delete_nodebalancer_config` - **OAuth scopes**. Your user needs these scopes assigned. [Learn more](https://techdocs.akamai.com/linode-api/reference/get-started#oauth). - Scopes: `nodebalancers:read_write` **CLI** ```shell linode-cli nodebalancers config-delete \ 12345 4567 ``` [Learn more](https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli) - [Rebuild a config](https://techdocs.akamai.com/linode-api/reference/post-rebuild-node-balancer-config.md): Rebuilds a NodeBalancer config and its nodes that you have permission to modify. Use this operation to update a NodeBalancer's config and nodes with a single request. You can't rebuild a NodeBalancer config if it has a `cannot_delete_with_subresources` lock. Only account administrators can remove locks using the [Delete a resource lock](ref:delete-resource-lock) operation. > 🚧 > > You can configure UDP on the same NodeBalancer that also uses TCP, HTTP, or HTTPS, but only when managing it through the API. If UDP is configured and you make changes to the TCP, HTTP or HTTPS settings in Cloud Manager, the existing UDP configuration will be overwritten. This is because Cloud Manager doesn't currently support UDP. **Permissions and scopes** To call this operation, you need permissions, based on the model you're using: - **Identity and access permissions**. Your user needs a role with these permissions. [Learn more](https://techdocs.akamai.com/cloud-computing/docs/identity-access-cm-available-roles). - Permissions: `rebuild_nodebalancer_config` - **OAuth scopes**. Your user needs these scopes assigned. [Learn more](https://techdocs.akamai.com/linode-api/reference/get-started#oauth). - Scopes: `nodebalancers:read_write` **CLI** *HTTPS* ```shell linode-cli nodebalancers config-rebuild \ 12345 4567 \ --port 443 \ --protocol https \ --algorithm roundrobin \ --stickiness http_cookie \ --check http_body \ --check_interval 90 \ --check_timeout 10 \ --check_attempts 3 \ --check_path "/test" \ --check_body "it works" \ --check_passive true \ --proxy_protocol "none" \ --ssl_cert "-----BEGIN CERTIFICATE----- CERTIFICATE_INFORMATION -----END CERTIFICATE-----" \ --ssl_key "-----BEGIN PRIVATE KEY----- PRIVATE_KEY_INFORMATION -----END PRIVATE KEY-----" \ --cipher_suite recommended \ --nodes.label "node1" --nodes.address "192.168.210.120:80" --nodes.mode "accept" --nodes.weight 50 \ --nodes '[{"address":"192.168.210.122:80","label":"node2","weight":50,"mode":"accept"}]' \ --nodes '[{"address":"10.0.0.45:80","label":"vpc-node","weight":10,"mode":"accept","subnet_id:1"}]' ``` *UDP* ```shell linode-cli nodebalancers config-rebuild \ 12345 4567 \ --port 80 \ --protocol udp \ --algorithm ring_hash \ --udp_check_port 80 \ --nodes.label "node1" --nodes.address "192.168.210.120:80" --nodes.mode "accept" --nodes.weight 50 \ --nodes '[{"address":"192.168.210.122:80","label":"node2","weight":50}]' \ --nodes '[{"address":"10.0.0.45:80","label":"vpc-node","weight":10,"mode":"accept","subnet_id:1"}]' ``` *TCP* ```shell linode-cli nodebalancers config-rebuild \ 12345 4567 \ --port 80 \ --protocol tcp \ --algorithm roundrobin \ --stickiness none \ --proxy_protocol "v2" --nodes.label "node1" --nodes.address "192.168.210.120:80" --nodes.mode "accept" --nodes.weight 50 \ --nodes '[{"address":"192.168.210.122:80","label":"node2","weight":50,"mode":"accept"}]' \ --nodes '[{"address":"10.0.0.45:80","label":"vpc-node","weight":10,"mode":"accept","subnet_id:1"}]' ``` *HTTP* ```shell linode-cli nodebalancers config-rebuild \ 12345 4567 \ --port 440 \ --protocol http \ --algorithm roundrobin \ --stickiness none \ --check http_body \ --check_interval 90 \ --check_timeout 10 \ --check_attempts 3 \ --check_path "/test" \ --check_body "it works" \ --nodes.label "node1" --nodes.address "192.168.210.120:80" --nodes.mode "accept" --nodes.weight 50 \ --nodes '[{"address":"192.168.210.122:80","label":"node2","weight":50,"mode":"accept"}]' \ --nodes '[{"address":"10.0.0.45:80","label":"vpc-node","weight":10,"mode":"accept","subnet_id:1"}]' ``` [Learn more](https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli) - [Create a node](https://techdocs.akamai.com/linode-api/reference/post-node-balancer-node.md): Creates a backend node that can receive traffic for the NodeBalancer configuration. Requests are routed to backend nodes on the specified port based on their `status`. The configurable fields for the backend node depend on the chosen protocol and whether the node is located within a Linode VPC. After creating a NodeBalancer backend node, account administrators can add a lock to prevent accidental node deletion by using the [Create a resource lock](ref:post-resource-lock) operation. > 🚧 > > You can configure UDP on the same NodeBalancer that also uses TCP, HTTP, or HTTPS, but only when managing it through the API. If UDP is configured and you make changes to the TCP, HTTP or HTTPS settings in Cloud Manager, the existing UDP configuration will be overwritten. This is because Cloud Manager doesn't currently support UDP. **Permissions and scopes** To call this operation, you need permissions, based on the model you're using: - **Identity and access permissions**. Your user needs a role with these permissions. [Learn more](https://techdocs.akamai.com/cloud-computing/docs/identity-access-cm-available-roles). - Permissions: `create_nodebalancer_config_node` - **OAuth scopes**. Your user needs these scopes assigned. [Learn more](https://techdocs.akamai.com/linode-api/reference/get-started#oauth). - Scopes: `nodebalancers:read_write` **CLI** *TCP, HTTP, HTTPS* ```shell linode-cli nodebalancers node-create \ 12345 4567 \ --address 10.0.0.45:80 \ --label node54321 \ --weight 50 \ --mode accept \ --subnet_id 1 ``` *UDP* ```shell linode-cli nodebalancers node-create \ 12345 4567 \ --address 192.168.210.120:80 \ --label node54321 \ --weight 50 ``` [Learn more](https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli) - [List nodes](https://techdocs.akamai.com/linode-api/reference/get-node-balancer-config-nodes.md): Returns a paginated list of NodeBalancer nodes associated with this Config. These are the backends that will be sent traffic for this port. **Permissions and scopes** To call this operation, you need permissions, based on the model you're using: - **Identity and access permissions**. Your user needs a role with these permissions. [Learn more](https://techdocs.akamai.com/cloud-computing/docs/identity-access-cm-available-roles). - Permissions: `list_nodebalancer_config_nodes` - **OAuth scopes**. Your user needs these scopes assigned. [Learn more](https://techdocs.akamai.com/linode-api/reference/get-started#oauth). - Scopes: `nodebalancers:read_only` **CLI** ```shell linode-cli nodebalancers nodes-list 12345 4567 ``` [Learn more](https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli) - [Get a NodeBalancer's node](https://techdocs.akamai.com/linode-api/reference/get-node-balancer-node.md): Returns information about a single Node, a backend for this NodeBalancer's configured port. **Permissions and scopes** To call this operation, you need permissions, based on the model you're using: - **Identity and access permissions**. Your user needs a role with these permissions. [Learn more](https://techdocs.akamai.com/cloud-computing/docs/identity-access-cm-available-roles). - Permissions: `view_nodebalancer_config_node` - **OAuth scopes**. Your user needs these scopes assigned. [Learn more](https://techdocs.akamai.com/linode-api/reference/get-started#oauth). - Scopes: `nodebalancers:read_write` **CLI** ```shell linode-cli nodebalancers node-view 12345 4567 54321 ``` [Learn more](https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli) - [Update a node](https://techdocs.akamai.com/linode-api/reference/put-node-balancer-node.md): Updates information about a node, a backend for this NodeBalancer's configured port. The fields available for the backend node depend on the configuration's protocol, and if the backend node is in a VPC. > 🚧 > > You can configure UDP on the same NodeBalancer that also uses TCP, HTTP, or HTTPS, but only when managing it through the API. If UDP is configured and you make changes to the TCP, HTTP or HTTPS settings in Cloud Manager, the existing UDP configuration will be overwritten. This is because Cloud Manager doesn't currently support UDP. **Permissions and scopes** To call this operation, you need permissions, based on the model you're using: - **Identity and access permissions**. Your user needs a role with these permissions. [Learn more](https://techdocs.akamai.com/cloud-computing/docs/identity-access-cm-available-roles). - Permissions: `update_nodebalancer_config_node` - **OAuth scopes**. Your user needs these scopes assigned. [Learn more](https://techdocs.akamai.com/linode-api/reference/get-started#oauth). - Scopes: `nodebalancers:read_write` **CLI** *TCP, HTTP, HTTPS* ```shell linode-cli nodebalancers node-update \ 12345 4567 54321 \ --address 192.168.210.120:80 \ --label node54321 \ --weight 50 \ --mode accept ``` *UDP* ```shell linode-cli nodebalancers node-create \ 12345 4567 \ --address 192.168.210.120:80 \ --label node54321 \ --weight 50 ``` [Learn more](https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli) - [Delete a NodeBalancer's node](https://techdocs.akamai.com/linode-api/reference/delete-node-balancer-config-node.md): Deletes a node from a configuration. This backend will no longer receive traffic for the configured port of this NodeBalancer. A NodeBalancer backend node can't be deleted if it has a `cannot_delete_with_subresources` lock. Only account administrators can remove locks using the [Delete a resource lock](ref:delete-resource-lock) operation. This does not change or remove the Linode whose address was used in the creation of this node. **Permissions and scopes** To call this operation, you need permissions, based on the model you're using: - **Identity and access permissions**. Your user needs a role with these permissions. [Learn more](https://techdocs.akamai.com/cloud-computing/docs/identity-access-cm-available-roles). - Permissions: `delete_nodebalancer_config_node` - **OAuth scopes**. Your user needs these scopes assigned. [Learn more](https://techdocs.akamai.com/linode-api/reference/get-started#oauth). - Scopes: `nodebalancers:read_write` **CLI** ```shell linode-cli nodebalancers node-delete \ 12345 4567 54321 ``` [Learn more](https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli) - [List NodeBalancer firewalls](https://techdocs.akamai.com/linode-api/reference/get-node-balancer-firewalls.md): View information for Firewalls assigned to this NodeBalancer. **Permissions and scopes** To call this operation, you need permissions, based on the model you're using: - **Identity and access permissions**. Your user needs a role with these permissions. [Learn more](https://techdocs.akamai.com/cloud-computing/docs/identity-access-cm-available-roles). - Permissions: `list_nodebalancer_firewalls` - **OAuth scopes**. Your user needs these scopes assigned. [Learn more](https://techdocs.akamai.com/linode-api/reference/get-started#oauth). - Scopes: `nodebalancers:read_only` **CLI** ```shell linode-cli nodebalancers firewalls $nodeBalancerId ``` [Learn more](https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli) - [Update a NodeBalancer's firewalls](https://techdocs.akamai.com/linode-api/reference/put-node-balancer-firewalls.md): Replace the current list of assigned firewalls with a new list, or provide an empty list to remove all firewalls from this NodeBalancer. **Permissions and scopes** To call this operation, you need permissions, based on the model you're using: - **Identity and access permissions**. Your user needs a role with these permissions. [Learn more](https://techdocs.akamai.com/cloud-computing/docs/identity-access-cm-available-roles). - Permissions: `update_nodebalancer_firewalls` - **OAuth scopes**. Your user needs these scopes assigned. [Learn more](https://techdocs.akamai.com/linode-api/reference/get-started#oauth). - Scopes: `nodebalancers:read_write` **CLI** ```shell linode-cli nodebalancers firewalls-update 12345 \ --firewall_ids '[1234, 4567]' ``` [Learn more](https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli) - [Get NodeBalancer statistics](https://techdocs.akamai.com/linode-api/reference/get-node-balancer-stats.md): Returns detailed statistics about the requested NodeBalancer. **Permissions and scopes** To call this operation, you need permissions, based on the model you're using: - **Identity and access permissions**. Your user needs a role with these permissions. [Learn more](https://techdocs.akamai.com/cloud-computing/docs/identity-access-cm-available-roles). - Permissions: `view_nodebalancer_statistics` - **OAuth scopes**. Your user needs these scopes assigned. [Learn more](https://techdocs.akamai.com/linode-api/reference/get-started#oauth). - Scopes: `nodebalancers:read_only` - [List VPC configurations](https://techdocs.akamai.com/linode-api/reference/get-node-balancer-vpcs.md): Returns a paginated list of VPC configurations for the NodeBalancer. **Permissions and scopes** To call this operation, you need permissions, based on the model you're using: - **Identity and access permissions**. Your user needs a role with these permissions. [Learn more](https://techdocs.akamai.com/cloud-computing/docs/identity-access-cm-available-roles). - Permissions: `list_nodebalancer_vpc_configs` - **OAuth scopes**. Your user needs these scopes assigned. [Learn more](https://techdocs.akamai.com/linode-api/reference/get-started#oauth). - Scopes: `nodebalancers:read_only` **CLI** ```shell linode-cli nodebalancers vpcs-list 12345 ``` [Learn more](https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli) - [Get a VPC configuration](https://techdocs.akamai.com/linode-api/reference/get-node-balancer-vpc-config.md): Returns a single VPC configuration for the NodeBalancer ID. **Permissions and scopes** To call this operation, you need permissions, based on the model you're using: - **Identity and access permissions**. Your user needs a role with these permissions. [Learn more](https://techdocs.akamai.com/cloud-computing/docs/identity-access-cm-available-roles). - Permissions: `view_nodebalancer_vpc_config` - **OAuth scopes**. Your user needs these scopes assigned. [Learn more](https://techdocs.akamai.com/linode-api/reference/get-started#oauth). - Scopes: `nodebalancers:read_only` **CLI** ```shell linode-cli nodebalancers vpcs-view \ 12345 7 ``` [Learn more](https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli) - [List Object Storage types](https://techdocs.akamai.com/linode-api/reference/get-object-storage-types.md): Returns Object Storage types and prices, including any region-specific rates. **CLI** ```shell linode-cli object-storage types ``` [Learn more](https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli) - [Get Object Storage transfer data](https://techdocs.akamai.com/linode-api/reference/get-object-storage-transfer.md): The amount of outbound data transfer used by your account's Object Storage buckets. Object Storage adds 1 terabyte of outbound data transfer to your data transfer pool. See the [Pricing](https://techdocs.akamai.com/cloud-computing/docs/object-storage-pricing#network-transfer) guide for details on Object Storage transfer quotas. **Permissions and scopes** To call this operation, you need permissions, based on the model you're using: - **OAuth scopes**. Your user needs these scopes assigned. [Learn more](https://techdocs.akamai.com/linode-api/reference/get-started#oauth). - Scopes: `object_storage:read_only` **CLI** ```shell linode-cli object-storage transfer-view ``` [Learn more](https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli) - [Cancel Object Storage](https://techdocs.akamai.com/linode-api/reference/post-cancel-object-storage.md): Cancel Object Storage on an Account. > 🚧 > > This removes all buckets and their contents from your Account. This data is irretrievable once removed. **Permissions and scopes** To call this operation, you need permissions, based on the model you're using: - **OAuth scopes**. Your user needs these scopes assigned. [Learn more](https://techdocs.akamai.com/linode-api/reference/get-started#oauth). - Scopes: `object_storage:read_write` **CLI** ```shell linode-cli object-storage cancel ``` [Learn more](https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli) - [Create an Object Storage access key](https://techdocs.akamai.com/linode-api/reference/post-object-storage-keys.md): Generates a new Object Storage access key and an associated secret key. The secret key is only displayed when the access key is generated and cannot be viewed again. A successful request triggers an `obj_access_key_create` [event](ref:get-events). > 📘 > > - Accounts with negative balances can't access this operation. > > - This operation has specific [rate limits](ref:rate-limits#specific-operation-rate-limits). **Unlimited vs. limited access keys** An unlimited access key grants full access to all of your buckets in each region you name, using the `regions` array. A limited access key lets you name specific buckets where you need to manage content, using the `bucket_access` array. > 👍 There's a tutorial > > We offer workflows for both an [unlimited access key](ref:create-an-unlimited-access-key) and a [limited access key](ref:create-a-limited-access-key). **Permissions and scopes** To call this operation, you need permissions, based on the model you're using: - **OAuth scopes**. Your user needs these scopes assigned. [Learn more](https://techdocs.akamai.com/linode-api/reference/get-started#oauth). - Scopes: `object_storage:read_write` **CLI** ```shell linode-cli object-storage keys-create \ --label "my-object-storage-key" \ --bucket_access '[{"region": "ap-south", "bucket_name": "bucket-example-1", "permissions": "read_write" }]' ``` [Learn more](https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli) - [List Object Storage access keys](https://techdocs.akamai.com/linode-api/reference/get-object-storage-keys.md): Returns a paginated list of Object Storage access keys for authentication. **Permissions and scopes** To call this operation, you need permissions, based on the model you're using: - **OAuth scopes**. Your user needs these scopes assigned. [Learn more](https://techdocs.akamai.com/linode-api/reference/get-started#oauth). - Scopes: `object_storage:read_only` **CLI** ```shell linode-cli object-storage keys-list ``` [Learn more](https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli) - [Get an Object Storage access key](https://techdocs.akamai.com/linode-api/reference/get-object-storage-key.md): Returns a single Object Storage access key. **Permissions and scopes** To call this operation, you need permissions, based on the model you're using: - **OAuth scopes**. Your user needs these scopes assigned. [Learn more](https://techdocs.akamai.com/linode-api/reference/get-started#oauth). - Scopes: `object_storage:read_only` **CLI** ```shell linode-cli object-storage keys-view \ --keyId 12345 ``` [Learn more](https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli) - [Update an Object Storage access key](https://techdocs.akamai.com/linode-api/reference/put-object-storage-key.md): Updates an Object Storage access key on your account. A successful request triggers an `obj_access_key_update` [event](ref:get-events). > 📘 > > This operation has specific [rate limits](ref:rate-limits#specific-operation-rate-limits). **Permissions and scopes** To call this operation, you need permissions, based on the model you're using: - **OAuth scopes**. Your user needs these scopes assigned. [Learn more](https://techdocs.akamai.com/linode-api/reference/get-started#oauth). - Scopes: `object_storage:read_write` **CLI** ```shell linode-cli object-storage keys-update \ --keyId 12345 --label "my-object-storage-key" ``` [Learn more](https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli) - [Revoke an Object Storage access key](https://techdocs.akamai.com/linode-api/reference/delete-object-storage-key.md): Revokes an Object Storage access key. Once revoked, the access key can no longer be used by third-party clients. A successful request triggers an `obj_access_key_delete` [event](ref:get-events). > 📘 > > This operation has specific [rate limits](ref:rate-limits#specific-operation-rate-limits). **Permissions and scopes** To call this operation, you need permissions, based on the model you're using: - **OAuth scopes**. Your user needs these scopes assigned. [Learn more](https://techdocs.akamai.com/linode-api/reference/get-started#oauth). - Scopes: `object_storage:read_write` **CLI** ```shell linode-cli object-storage keys-delete 12345 ``` [Learn more](https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli) - [Create an Object Storage bucket](https://techdocs.akamai.com/linode-api/reference/post-object-storage-bucket.md): Creates an Object Storage bucket in the specified data center ([region](ref:get-regions)). If the bucket already exists on your account, this operation returns a 200 response with that bucket as if the API just created it. > 📘 > > - Accounts with negative balances can't access this operation. > > - The API still supports the `clusterId` equivalent (`us-west-1`) when setting a `region` for a new bucket, but you should use the `regionId` (`us-west`) instead. > > - This operation has specific [rate limits](ref:rate-limits#specific-operation-rate-limits). **Permissions and scopes** To call this operation, you need permissions, based on the model you're using: - **OAuth scopes**. Your user needs these scopes assigned. [Learn more](https://techdocs.akamai.com/linode-api/reference/get-started#oauth). - Scopes: `object_storage:read_write` - [List Object Storage buckets](https://techdocs.akamai.com/linode-api/reference/get-object-storage-buckets.md): Returns a paginated list of all Object Storage buckets available in your account. **Permissions and scopes** To call this operation, you need permissions, based on the model you're using: - **OAuth scopes**. Your user needs these scopes assigned. [Learn more](https://techdocs.akamai.com/linode-api/reference/get-started#oauth). - Scopes: `object_storage:read_only` - [Get an Object Storage bucket](https://techdocs.akamai.com/linode-api/reference/get-object-storage-bucket.md): Returns a single Object Storage bucket. **Permissions and scopes** To call this operation, you need permissions, based on the model you're using: - **OAuth scopes**. Your user needs these scopes assigned. [Learn more](https://techdocs.akamai.com/linode-api/reference/get-started#oauth). - Scopes: `object_storage:read_only` - [List Object Storage buckets per region](https://techdocs.akamai.com/linode-api/reference/get-object-storage-bucketin-cluster.md): Returns a list of buckets on your account, in the specified region. **Permissions and scopes** To call this operation, you need permissions, based on the model you're using: - **OAuth scopes**. Your user needs these scopes assigned. [Learn more](https://techdocs.akamai.com/linode-api/reference/get-started#oauth). - Scopes: `object_storage:read_only` - [Remove an Object Storage bucket](https://techdocs.akamai.com/linode-api/reference/delete-object-storage-bucket.md): Removes a single bucket. > 📘 > > - You need to remove all objects from a bucket before you can delete it. > > - While you can delete a bucket using the [CLI](https://techdocs.akamai.com/cloud-computing/docs/using-s3cmd-with-object-storage#delete-a-bucket), this operation fails if the bucket contains too many objects. The best way to empty large buckets is to configure [lifecycle policies](https://techdocs.akamai.com/cloud-computing/docs/lifecycle-policies). Set a policy to remove all objects, wait a day or more for the system to remove all objects, then you can use the CLI to delete the bucket. **Permissions and scopes** To call this operation, you need permissions, based on the model you're using: - **OAuth scopes**. Your user needs these scopes assigned. [Learn more](https://techdocs.akamai.com/linode-api/reference/get-started#oauth). - Scopes: `object_storage:read_write` - [Allow access to an Object Storage bucket](https://techdocs.akamai.com/linode-api/reference/post-object-storage-bucket-access.md): Apply basic cross-origin resource sharing (CORS) and [S3 canned access control list (ACL)](https://docs.aws.amazon.com/AmazonS3/latest/userguide/acl-overview.html#canned-acl) settings. > 📘 > > - CORS is only supported with [legacy endpoints (E0 and E1)](https://techdocs.akamai.com/cloud-computing/docs/endpoint-types). > > - You can use the S3 API for more fine-grained control of the [CORS](https://docs.aws.amazon.com/AmazonS3/latest/userguide/enabling-cors-examples.html) or [S3 canned ACL](https://docs.aws.amazon.com/AmazonS3/latest/userguide/managing-acls.html) settings. **Permissions and scopes** To call this operation, you need permissions, based on the model you're using: - **OAuth scopes**. Your user needs these scopes assigned. [Learn more](https://techdocs.akamai.com/linode-api/reference/get-started#oauth). - Scopes: `object_storage:read_write` - [Get Object Storage bucket access](https://techdocs.akamai.com/linode-api/reference/get-object-storage-bucket-access.md): View the cross-origin resource sharing (CORS) and [S3 canned access control (ACL)](https://docs.aws.amazon.com/AmazonS3/latest/userguide/acl-overview.html#canned-acl) settings for a specific Object Storage bucket. > 📘 > > You can use the S3 API to view more details on [CORS](https://docs.aws.amazon.com/AmazonS3/latest/userguide/enabling-cors-examples.html) or [S3 canned ACL](https://docs.aws.amazon.com/AmazonS3/latest/userguide/managing-acls.html) settings. **Permissions and scopes** To call this operation, you need permissions, based on the model you're using: - **OAuth scopes**. Your user needs these scopes assigned. [Learn more](https://techdocs.akamai.com/linode-api/reference/get-started#oauth). - Scopes: `object_storage:read_only` - [Update access to an Object Storage bucket](https://techdocs.akamai.com/linode-api/reference/put-storage-bucket-access.md): Update basic cross-origin resource sharing (CORS) and [S3 canned access control list (ACL)](https://docs.aws.amazon.com/AmazonS3/latest/userguide/acl-overview.html#canned-acl) settings. > 📘 > > - CORS is only supported with [legacy endpoints (E0 and E1)](https://techdocs.akamai.com/cloud-computing/docs/endpoint-types). > > - You can use the S3 API for more fine-grained control of the [CORS](https://docs.aws.amazon.com/AmazonS3/latest/userguide/enabling-cors-examples.html) or [S3 canned ACL](https://docs.aws.amazon.com/AmazonS3/latest/userguide/managing-acls.html) settings. **Permissions and scopes** To call this operation, you need permissions, based on the model you're using: - **OAuth scopes**. Your user needs these scopes assigned. [Learn more](https://techdocs.akamai.com/linode-api/reference/get-started#oauth). - Scopes: `object_storage:read_write` - [List Object Storage bucket contents](https://techdocs.akamai.com/linode-api/reference/get-object-storage-bucket-content.md): Returns the contents of a bucket. The contents are paginated using a `marker`, that's the name of the last object on the previous page. Objects can also be filtered by `prefix` and `delimiter`. See [Filtering and sorting](ref:filtering-and-sorting) for more information. **Permissions and scopes** To call this operation, you need permissions, based on the model you're using: - **OAuth scopes**. Your user needs these scopes assigned. [Learn more](https://techdocs.akamai.com/linode-api/reference/get-started#oauth). - Scopes: `object_storage:read_only` - [Create a URL for an object](https://techdocs.akamai.com/linode-api/reference/post-object-storage-object-url.md): Creates a pre-signed URL to access a single object in a bucket. Use it to share, create, or delete objects by using the appropriate HTTP method in your request body's `method` parameter. **Permissions and scopes** To call this operation, you need permissions, based on the model you're using: - **OAuth scopes**. Your user needs these scopes assigned. [Learn more](https://techdocs.akamai.com/linode-api/reference/get-started#oauth). - Scopes: `object_storage:read_write` - [Get an Object Storage object ACL configuration](https://techdocs.akamai.com/linode-api/reference/get-object-storage-bucket-acl.md): View a specific object's access control list (ACL) settings. ACLs define who can access your buckets and objects and specify the level of access granted to those users. See [Define access and permissions using ACLs (Access Control Lists)](https://techdocs.akamai.com/cloud-computing/docs/define-access-and-permissions-using-acls-access-control-lists). **Permissions and scopes** To call this operation, you need permissions, based on the model you're using: - **OAuth scopes**. Your user needs these scopes assigned. [Learn more](https://techdocs.akamai.com/linode-api/reference/get-started#oauth). - Scopes: `object_storage:read_only` - [Update an object's ACL configuration](https://techdocs.akamai.com/linode-api/reference/put-object-storage-bucket-acl.md): Update a specific object's access control list (ACL) settings. ACLs define who can access your buckets and objects, and specify the level of access granted to those users. See [Define access and permissions using ACLs (Access Control Lists)](https://techdocs.akamai.com/cloud-computing/docs/define-access-and-permissions-using-acls-access-control-lists). **Permissions and scopes** To call this operation, you need permissions, based on the model you're using: - **OAuth scopes**. Your user needs these scopes assigned. [Learn more](https://techdocs.akamai.com/linode-api/reference/get-started#oauth). - Scopes: `object_storage:read_write` - [Add a TLS/SSL certificate to a bucket](https://techdocs.akamai.com/linode-api/reference/post-object-storage-ssl.md): Upload a TLS/SSL certificate and private key to be served when you visit your Object Storage bucket via HTTPS. Your TLS/SSL certificate and private key are encrypted and stored at rest. To replace an expired certificate, [delete your current certificates](ref:delete-object-storage-ssl) and upload a new one. > 📘 > > TLS/SSL certificates are only supported with [legacy endpoints (E0 and E1)](https://techdocs.akamai.com/cloud-computing/docs/endpoint-types). **Permissions and scopes** To call this operation, you need permissions, based on the model you're using: - **OAuth scopes**. Your user needs these scopes assigned. [Learn more](https://techdocs.akamai.com/linode-api/reference/get-started#oauth). - Scopes: `object_storage:read_write` **CLI** ```shell linode-cli object-storage ssl-upload \ us-east-1 example-bucket \ --certificate "-----BEGIN CERTIFICATE----- CERTIFICATE_INFORMATION -----END CERTIFICATE-----" \ --private_key "-----BEGIN PRIVATE KEY----- PRIVATE_KEY_INFORMATION -----END PRIVATE KEY-----" ``` [Learn more](https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli) - [Get a bucket's TLS/SSL certificate](https://techdocs.akamai.com/linode-api/reference/get-object-storage-ssl.md): Whether this bucket has a corresponding TLS/SSL certificate that was uploaded by a user on your account. > 📘 > > TLS/SSL certificates are only supported with [legacy endpoints (E0 and E1)](https://techdocs.akamai.com/cloud-computing/docs/endpoint-types). **Permissions and scopes** To call this operation, you need permissions, based on the model you're using: - **OAuth scopes**. Your user needs these scopes assigned. [Learn more](https://techdocs.akamai.com/linode-api/reference/get-started#oauth). - Scopes: `object_storage:read_only` **CLI** ```shell linode-cli object-storage ssl-view \ us-east-1 example-bucket ``` [Learn more](https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli) - [Delete a bucket's TLS/SSL certificate](https://techdocs.akamai.com/linode-api/reference/delete-object-storage-ssl.md): Deletes this Object Storage bucket's user uploaded TLS/SSL certificate and private key. **Permissions and scopes** To call this operation, you need permissions, based on the model you're using: - **OAuth scopes**. Your user needs these scopes assigned. [Learn more](https://techdocs.akamai.com/linode-api/reference/get-started#oauth). - Scopes: `object_storage:read_write` **CLI** ```shell linode-cli object-storage ssl-delete \ us-east-1 example-bucket ``` [Learn more](https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli) - [List clusters](https://techdocs.akamai.com/linode-api/reference/get-object-storage-clusters.md): __Deprecated__ Returns a paginated list of available Object Storage clusters. > 🚧 > > This displays deprecated `clusterId` values that represent regions used with older versions of the API. It's maintained for backward compatibility. Run [List Object Storage endpoints](ref:get-object-storage-endpoints) instead. **Permissions and scopes** To call this operation, you need permissions, based on the model you're using: - **OAuth scopes**. Your user needs these scopes assigned. [Learn more](https://techdocs.akamai.com/linode-api/reference/get-started#oauth). - Scopes: `object_storage:read_only` **CLI** ```shell linode-cli object-storage clusters-list ``` [Learn more](https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli) - [Get a cluster](https://techdocs.akamai.com/linode-api/reference/get-object-storage-cluster.md): __Deprecated__ Returns a single Object Storage cluster. > 🚧 > > This displays deprecated `clusterId` values that represent regions used with older versions of the API. It's maintained for backward compatibility. Run [Get a region](ref:get-region) instead. **Permissions and scopes** To call this operation, you need permissions, based on the model you're using: - **OAuth scopes**. Your user needs these scopes assigned. [Learn more](https://techdocs.akamai.com/linode-api/reference/get-started#oauth). - Scopes: `object_storage:read_only` **CLI** ```shell linode-cli object-storage clusters-view us-east-1 ``` [Learn more](https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli) - [List Object Storage endpoints](https://techdocs.akamai.com/linode-api/reference/get-object-storage-endpoints.md): Returns a paginated list of all Object Storage [endpoints](https://techdocs.akamai.com/cloud-computing/docs/endpoint-types) available in your account. **Permissions and scopes** To call this operation, you need permissions, based on the model you're using: - **OAuth scopes**. Your user needs these scopes assigned. [Learn more](https://techdocs.akamai.com/linode-api/reference/get-started#oauth). - Scopes: `object_storage:read_only` **CLI** ```shell linode-cli object-storage endpoints ``` [Learn more](https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli) - [List Object Storage quotas](https://techdocs.akamai.com/linode-api/reference/get-object-storage-quotas.md): Returns the active Object Storage-related quotas applied to your account. For example, you may have a quota for the maximum number of buckets you can have on a single endpoint. The operation includes any quota overrides in the response. > 📘 > > You can't combine parameters when [filtering](ref:filtering-and-sorting) with this operation. Only a single filterable parameter can be used. **Permissions and scopes** To call this operation, you need permissions, based on the model you're using: - **OAuth scopes**. Your user needs these scopes assigned. [Learn more](https://techdocs.akamai.com/linode-api/reference/get-started#oauth). - Scopes: `object_storage:read_only` **CLI** ```shell linode-cli object-storage quotas-list ``` [Learn more](https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli) - [Get an Object Storage quota](https://techdocs.akamai.com/linode-api/reference/get-object-storage-quota.md): Returns information about a specific Object Storage-related quota on your account. The operation includes any quota overrides in the response. **Permissions and scopes** To call this operation, you need permissions, based on the model you're using: - **OAuth scopes**. Your user needs these scopes assigned. [Learn more](https://techdocs.akamai.com/linode-api/reference/get-started#oauth). - Scopes: `object_storage:read_only` **CLI** ```shell linode-cli object-storage quota-view obj-objects-us-ord-1 ``` [Learn more](https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli) - [Get Object Storage quota usage data](https://techdocs.akamai.com/linode-api/reference/get-object-storage-quota-usage.md): Returns usage data for a specific `objQuotaId`. This includes the maximum number of `objQuotaId` resources you can have for a single endpoint and the current usage for that resource. **Permissions and scopes** To call this operation, you need permissions, based on the model you're using: - **OAuth scopes**. Your user needs these scopes assigned. [Learn more](https://techdocs.akamai.com/linode-api/reference/get-started#oauth). - Scopes: `object_storage:read_only` **CLI** ```shell linode-cli object-storage quota-usage-view obj-objects-us-ord-1 ``` [Learn more](https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli) - [List Object Storage global quotas](https://techdocs.akamai.com/linode-api/reference/get-object-storage-global-quotas.md): Returns the active Object Storage-related global quotas applied to your account, such as the maximum number of access keys. The operation includes any quota overrides in the response. > 📘 > > You can't combine parameters when [filtering](ref:filtering-and-sorting) with this operation. Only a single filterable parameter can be used. **Permissions and scopes** To call this operation, you need permissions, based on the model you're using: - **OAuth scopes**. Your user needs these scopes assigned. [Learn more](https://techdocs.akamai.com/linode-api/reference/get-started#oauth). - Scopes: `object_storage:read_only` **CLI** ```shell linode-cli object-storage global-quotas-list ``` [Learn more](https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli) - [Get an Object Storage global quota](https://techdocs.akamai.com/linode-api/reference/get-object-storage-global-quota.md): Returns a specific Object Storage-related global quota on your account. The operation includes any quota overrides in the response. **Permissions and scopes** To call this operation, you need permissions, based on the model you're using: - **OAuth scopes**. Your user needs these scopes assigned. [Learn more](https://techdocs.akamai.com/linode-api/reference/get-started#oauth). - Scopes: `object_storage:read_only` **CLI** ```shell linode-cli object-storage global-quota-view keys ``` [Learn more](https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli) - [Get Object Storage global quota usage data](https://techdocs.akamai.com/linode-api/reference/get-object-storage-global-quota-usage.md): Returns usage data for a specific global quota (`objGlobalQuotaId`). This includes the maximum number of resources permitted by the quota and your current usage for that resource. **Permissions and scopes** To call this operation, you need permissions, based on the model you're using: - **OAuth scopes**. Your user needs these scopes assigned. [Learn more](https://techdocs.akamai.com/linode-api/reference/get-started#oauth). - Scopes: `object_storage:read_only` **CLI** ```shell linode-cli object-storage global-quota-usage-view keys ``` [Learn more](https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli) - [Create a placement group](https://techdocs.akamai.com/linode-api/reference/post-placement-group.md): Creates a placement group on your account. Placement groups disperse your Linodes across physical machines (hosts) in one of our compute regions. Depending on your workload requirements, you may need your Linodes to follow specific strategies: - __Grouped-together model__. You may want them placed close together to reduce latency between Linodes that are used for an application or workload. Affinity placement groups follow this model. - __Spread-apart model__. You may want to disperse them across several hosts to support high availability, for example when required for failover. Anti-affinity placement groups follow this model. To run this operation, your user needs the `add_linodes` [grant](ref:get-user-grants). Talk to your local account administrator about grant management for your user. > 👍 There's a tutorial > > We offer an example API [workflow](ref:create-a-placement-group) you can follow to create a placement group and add Linodes to it. **Permissions and scopes** To call this operation, you need permissions, based on the model you're using: - **OAuth scopes**. Your user needs these scopes assigned. [Learn more](https://techdocs.akamai.com/linode-api/reference/get-started#oauth). - Scopes: `linodes:read_write` **CLI** ```shell linode-cli placement group-create \ --label PG_Miami_failover \ --region us-mia \ --placement_group_type "anti_affinity:local" \ --placement_group_policy strict ``` [Learn more](https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli) - [List placement groups](https://techdocs.akamai.com/linode-api/reference/get-placement-groups.md): Returns a paginated list of placement groups you have permission to view. > 📘 > > Your user needs at least `read-only` [permission](ref:get-user-grants) to all Linodes included in a placement group to view it. Placement groups that contain Linodes that you don't have this permission for are left out of the response. If all placement groups contain Linodes that lack this permission, the API returns a 403 error. Talk to your local account administrator about managing permissions. **Permissions and scopes** To call this operation, you need permissions, based on the model you're using: - **OAuth scopes**. Your user needs these scopes assigned. [Learn more](https://techdocs.akamai.com/linode-api/reference/get-started#oauth). - Scopes: `placement:read_only` **CLI** ```shell linode-cli placement groups-list ``` [Learn more](https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli) - [Get a placement group](https://techdocs.akamai.com/linode-api/reference/get-placement-group.md): View a specific placement group by ID. > 📘 > > Your user needs at least `read-only` [permission](ref:get-user-grants) to all Linodes included in a placement group to view it. If you don't have this access and call this operation, the API returns a 403 error. Talk to your local account administrator about managing permissions. **Permissions and scopes** To call this operation, you need permissions, based on the model you're using: - **OAuth scopes**. Your user needs these scopes assigned. [Learn more](https://techdocs.akamai.com/linode-api/reference/get-started#oauth). - Scopes: `linodes:read_only` **CLI** ```shell linode-cli placement group-view 528 ``` [Learn more](https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli) - [Update a placement group](https://techdocs.akamai.com/linode-api/reference/put-placement-group.md): Change the `label` for a specific placement group. This is the only value you can update. However, you can [add](ref:post-group-add-linode) more Linodes or [remove](ref:post-group-unassign) existing ones. > 📘 > > To update a placement group, your [user grants](ref:get-user-grants) need to include `read_write` permission to all of the Linodes in the group. Talk to your local account administrator about grant management for your user. **Permissions and scopes** To call this operation, you need permissions, based on the model you're using: - **OAuth scopes**. Your user needs these scopes assigned. [Learn more](https://techdocs.akamai.com/linode-api/reference/get-started#oauth). - Scopes: `linodes:read_write` **CLI** ```shell linode-cli placement group-update 528 \ --label PG_Miami_failover_update ``` [Learn more](https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli) - [Delete a placement group](https://techdocs.akamai.com/linode-api/reference/delete-placement-group.md): Deletes a placement group you have permission to `read_write`. - Deleting a placement group can't be undone. - All Linodes need to be [removed](ref:post-group-unassign) before you can delete a placement group. - If your placement group is non-compliant, you can't delete it. You need to wait for our help to bring it [compliant](https://www.linode.com/docs/products/compute/compute-instances/guides/placement-groups/#non-compliance-precedence). <> > 📘 > > To run this operation, your user needs the `add_linodes` [grant](ref:get-user-grants). Talk to your local account administrator about grant management for your user. **Permissions and scopes** To call this operation, you need permissions, based on the model you're using: - **OAuth scopes**. Your user needs these scopes assigned. [Learn more](https://techdocs.akamai.com/linode-api/reference/get-started#oauth). - Scopes: `linodes:read_write` **CLI** ```shell linode-cli placement group-delete 528 ``` [Learn more](https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli) - [Assign a placement group](https://techdocs.akamai.com/linode-api/reference/post-group-add-linode.md): Add a Linode to your placement group. Check out our [example API workflow](ref:create-a-placement-group) to create a placement group and add Linodes. > 📘 > > Your user needs the `add_linodes` [grant](ref:get-user-grants) and `read-write` [permission](ref:get-user-grants) to the Linodes you want to add to the group. Talk to your local account administrator about grant and permissions management. **Permissions and scopes** To call this operation, you need permissions, based on the model you're using: - **OAuth scopes**. Your user needs these scopes assigned. [Learn more](https://techdocs.akamai.com/linode-api/reference/get-started#oauth). - Scopes: `linodes:read_write` **CLI** ```shell linode-cli placement assign-linode 528 \ --linodes 123 456 \ --non-compliant true ``` [Learn more](https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli) - [Unassign a placement group](https://techdocs.akamai.com/linode-api/reference/post-group-unassign.md): Remove a Linode from your placement group. > 📘 > > To run this operation, your user needs the `add_linodes` [grant](ref:get-user-grants) and `read-write` [permission](ref:get-user-grants) to the Linodes you want to remove from the group. Talk to your local account administrator about grant and permissions management. **Permissions and scopes** To call this operation, you need permissions, based on the model you're using: - **OAuth scopes**. Your user needs these scopes assigned. [Learn more](https://techdocs.akamai.com/linode-api/reference/get-started#oauth). - Scopes: `linodes:read_write` **CLI** ```shell linode-cli placement unassign-linode 528 \ --linode 123 456 ``` [Learn more](https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli) - [Get a profile](https://techdocs.akamai.com/linode-api/reference/get-profile.md): Returns information about the current user. Use this to see who is acting in applications where more than one token is managed, such as a third-party OAuth application. > 📘 > > A third-party OAuth application accessing a profile with this operation has full access to all aspects of that profile. **Permissions and scopes** To call this operation, you need permissions, based on the model you're using: - **Identity and access permissions**. Your user needs a role with these permissions. [Learn more](https://techdocs.akamai.com/cloud-computing/docs/identity-access-cm-available-roles). - Permissions: `view_profile` **CLI** ```shell linode-cli profile view ``` [Learn more](https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli) - [Update a profile](https://techdocs.akamai.com/linode-api/reference/put-profile.md): Update information in your profile. __Parent and child accounts__ In the context of the [parent and child accounts](https://techdocs.akamai.com/cloud-computing/docs/parent-and-child-accounts-for-akamai-partners) feature, delegate users on a child account can't change their email address. **Permissions and scopes** To call this operation, you need permissions, based on the model you're using: - **Identity and access permissions**. Your user needs a role with these permissions. [Learn more](https://techdocs.akamai.com/cloud-computing/docs/identity-access-cm-available-roles). - Permissions: `update_profile` - **OAuth scopes**. Your user needs these scopes assigned. [Learn more](https://techdocs.akamai.com/linode-api/reference/get-started#oauth). - Scopes: `account:read_write` **CLI** ```shell linode-cli profile update \ --email example-user@gmail.com \ --timezone US/Eastern \ --email_notifications true \ --list_auth_method keys_only \ --two_factor_auth true \ --restricted false ``` [Learn more](https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli) - [List authorized apps](https://techdocs.akamai.com/linode-api/reference/get-profile-apps.md): This is a collection of OAuth apps that you've given access to your account, and includes the level of access granted. **Permissions and scopes** To call this operation, you need permissions, based on the model you're using: - **Identity and access permissions**. Your user needs a role with these permissions. [Learn more](https://techdocs.akamai.com/cloud-computing/docs/identity-access-cm-available-roles). - Permissions: `list_profile_apps` - **OAuth scopes**. Your user needs these scopes assigned. [Learn more](https://techdocs.akamai.com/linode-api/reference/get-started#oauth). - Scopes: `account:read_only` **CLI** ```shell linode-cli profile apps-list ``` [Learn more](https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli) - [Get an authorized app](https://techdocs.akamai.com/linode-api/reference/get-profile-app.md): Returns information about a single app you've authorized to access your account. **Permissions and scopes** To call this operation, you need permissions, based on the model you're using: - **Identity and access permissions**. Your user needs a role with these permissions. [Learn more](https://techdocs.akamai.com/cloud-computing/docs/identity-access-cm-available-roles). - Permissions: `view_profile_app` - **OAuth scopes**. Your user needs these scopes assigned. [Learn more](https://techdocs.akamai.com/linode-api/reference/get-started#oauth). - Scopes: `account:read_only` **CLI** ```shell linode-cli profile app-view 1234 ``` [Learn more](https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli) - [Revoke app access](https://techdocs.akamai.com/linode-api/reference/delete-profile-app.md): Expires this app token. This token can no longer be used to access your account. **Permissions and scopes** To call this operation, you need permissions, based on the model you're using: - **Identity and access permissions**. Your user needs a role with these permissions. [Learn more](https://techdocs.akamai.com/cloud-computing/docs/identity-access-cm-available-roles). - Permissions: `revoke_profile_app` - **OAuth scopes**. Your user needs these scopes assigned. [Learn more](https://techdocs.akamai.com/linode-api/reference/get-started#oauth). - Scopes: `account:read_write` **CLI** ```shell linode-cli profile app-delete 123 ``` [Learn more](https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli) - [List trusted devices](https://techdocs.akamai.com/linode-api/reference/get-devices.md): Returns a paginated list of active trusted devices for your user. Browsers with an active Remember Me Session are logged into your account until the session expires or is revoked. **Permissions and scopes** To call this operation, you need permissions, based on the model you're using: - **Identity and access permissions**. Your user needs a role with these permissions. [Learn more](https://techdocs.akamai.com/cloud-computing/docs/identity-access-cm-available-roles). - Permissions: `list_profile_devices` - **OAuth scopes**. Your user needs these scopes assigned. [Learn more](https://techdocs.akamai.com/linode-api/reference/get-started#oauth). - Scopes: `account:read_only` **CLI** ```shell linode-cli profile devices-list ``` [Learn more](https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli) - [Get a trusted device](https://techdocs.akamai.com/linode-api/reference/get-trusted-device.md): Returns a single active trusted device for your user. **Permissions and scopes** To call this operation, you need permissions, based on the model you're using: - **Identity and access permissions**. Your user needs a role with these permissions. [Learn more](https://techdocs.akamai.com/cloud-computing/docs/identity-access-cm-available-roles). - Permissions: `view_profile_device` - **OAuth scopes**. Your user needs these scopes assigned. [Learn more](https://techdocs.akamai.com/linode-api/reference/get-started#oauth). - Scopes: `account:read_only` **CLI** ```shell linode-cli profile device-view 123 ``` [Learn more](https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli) - [Revoke a trusted device](https://techdocs.akamai.com/linode-api/reference/delete-trusted-device.md): Revoke an active trusted device for your user. Once a trusted device is revoked, this device will have to log in again before accessing your account. **Permissions and scopes** To call this operation, you need permissions, based on the model you're using: - **Identity and access permissions**. Your user needs a role with these permissions. [Learn more](https://techdocs.akamai.com/cloud-computing/docs/identity-access-cm-available-roles). - Permissions: `revoke_profile_device` - **OAuth scopes**. Your user needs these scopes assigned. [Learn more](https://techdocs.akamai.com/linode-api/reference/get-started#oauth). - Scopes: `account:read_write` **CLI** ```shell linode-cli profile device-revoke 123 ``` [Learn more](https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli) - [List grants](https://techdocs.akamai.com/linode-api/reference/get-profile-grants.md): This returns a GrantsResponse describing what the acting User has been granted access to. For unrestricted users, this will return a 204 and no body because unrestricted users have access to everything without grants. This will not return information about entities you do not have access to. This operation is useful when writing third-party OAuth applications to see what options you should present to the acting User. For example, if they do not have `global.add_linodes`, you might not display a button to deploy a new Linode. Any client may run this operation; no OAuth scopes are required. **Permissions and scopes** To call this operation, you need permissions, based on the model you're using: - **Identity and access permissions**. Your user needs a role with these permissions. [Learn more](https://techdocs.akamai.com/cloud-computing/docs/identity-access-cm-available-roles). - Permissions: `list_profile_grants` - [List logins](https://techdocs.akamai.com/linode-api/reference/get-profile-logins.md): Returns a collection of successful account logins from this user during the last 90 days. **Permissions and scopes** To call this operation, you need permissions, based on the model you're using: - **Identity and access permissions**. Your user needs a role with these permissions. [Learn more](https://techdocs.akamai.com/cloud-computing/docs/identity-access-cm-available-roles). - Permissions: `list_profile_logins` - **OAuth scopes**. Your user needs these scopes assigned. [Learn more](https://techdocs.akamai.com/linode-api/reference/get-started#oauth). - Scopes: `account:read_only` **CLI** ```shell linode-cli profile logins-list ``` [Learn more](https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli) - [Get a profile's login](https://techdocs.akamai.com/linode-api/reference/get-profile-login.md): Returns a login object displaying information about a successful account login from this user. **Permissions and scopes** To call this operation, you need permissions, based on the model you're using: - **Identity and access permissions**. Your user needs a role with these permissions. [Learn more](https://techdocs.akamai.com/cloud-computing/docs/identity-access-cm-available-roles). - Permissions: `view_profile_login` - **OAuth scopes**. Your user needs these scopes assigned. [Learn more](https://techdocs.akamai.com/linode-api/reference/get-started#oauth). - Scopes: `account:read_only` **CLI** ```shell linode-cli profile login-view 1234 ``` [Learn more](https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli) - [Send a phone number verification code](https://techdocs.akamai.com/linode-api/reference/post-profile-phone-number.md): Send a one-time verification code via SMS message to the submitted phone number. Providing your phone number helps ensure you can securely access your Account in case other ways to connect are lost. Your phone number is only used to verify your identity by sending an SMS message. Standard carrier messaging fees may apply. - By accessing this operation you are opting in to receive SMS messages. You can opt out of SMS messages by running the [Delete a phone number](ref:delete-profile-phone-number) operation after your phone number is verified. - Verification codes are valid for 10 minutes after they are sent. - Subsequent requests made prior to code expiration result in sending the same code. Once a verification code is received, verify your phone number with the [Verify a phone number](ref:post-profile-phone-number-verify) operation. **Permissions and scopes** To call this operation, you need permissions, based on the model you're using: - **Identity and access permissions**. Your user needs a role with these permissions. [Learn more](https://techdocs.akamai.com/cloud-computing/docs/identity-access-cm-available-roles). - Permissions: `send_profile_phone_number_verification_code` - **OAuth scopes**. Your user needs these scopes assigned. [Learn more](https://techdocs.akamai.com/linode-api/reference/get-started#oauth). - Scopes: `account:read_write` **CLI** ```shell linode-cli phone sms-code-send \ --iso-code US \ --phone-number 555-555-5555 ``` [Learn more](https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli) - [Delete a phone number](https://techdocs.akamai.com/linode-api/reference/delete-profile-phone-number.md): Delete the verified phone number for the User making this request. Use this operation to opt out of SMS messages for the requesting User after a phone number has been verified with the [Verify a phone number](ref:post-profile-phone-number-verify) operation. **Permissions and scopes** To call this operation, you need permissions, based on the model you're using: - **Identity and access permissions**. Your user needs a role with these permissions. [Learn more](https://techdocs.akamai.com/cloud-computing/docs/identity-access-cm-available-roles). - Permissions: `delete_profile_phone_number` - **OAuth scopes**. Your user needs these scopes assigned. [Learn more](https://techdocs.akamai.com/linode-api/reference/get-started#oauth). - Scopes: `account:read_write` **CLI** ```shell linode-cli phone delete ``` [Learn more](https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli) - [Verify a phone number](https://techdocs.akamai.com/linode-api/reference/post-profile-phone-number-verify.md): Verify a phone number by confirming the one-time code received via SMS message after running the [Send a phone number verification code](ref:post-profile-phone-number) operation. - Verification codes are valid for 10 minutes after they are sent. - Only the same User that made the verification code request can use that code with this operation. Once completed, the verified phone number is assigned to the User making the request. To change the verified phone number for a User, first run the [Delete a phone number](ref:delete-profile-phone-number) operation, then begin the verification process again with the [Send a phone number verification code](ref:post-profile-phone-number) operation. **Permissions and scopes** To call this operation, you need permissions, based on the model you're using: - **Identity and access permissions**. Your user needs a role with these permissions. [Learn more](https://techdocs.akamai.com/cloud-computing/docs/identity-access-cm-available-roles). - Permissions: `verify_profile_phone_number` - **OAuth scopes**. Your user needs these scopes assigned. [Learn more](https://techdocs.akamai.com/linode-api/reference/get-started#oauth). - Scopes: `account:read_write` **CLI** ```shell linode-cli phone verify \ --otp_code 123456 ``` [Learn more](https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli) - [Get user preferences](https://techdocs.akamai.com/linode-api/reference/get-user-preferences.md): View a list of user preferences tied to the OAuth client that generated the token making the request. The user preferences endpoints allow consumers of the API to store arbitrary JSON data, such as a user's font size preference or preferred display name. User preferences are available for each OAuth client registered to your account, and as such an account can have multiple user preferences. **Permissions and scopes** To call this operation, you need permissions, based on the model you're using: - **Identity and access permissions**. Your user needs a role with these permissions. [Learn more](https://techdocs.akamai.com/cloud-computing/docs/identity-access-cm-available-roles). - Permissions: `view_user_preference` - **OAuth scopes**. Your user needs these scopes assigned. [Learn more](https://techdocs.akamai.com/linode-api/reference/get-started#oauth). - Scopes: `account:read_only` - [Update a user's preferences](https://techdocs.akamai.com/linode-api/reference/put-user-preferences.md): Updates a user's preferences. These preferences are tied to the OAuth client that generated the token making the request. The user preferences endpoints allow consumers of the API to store arbitrary JSON data, such as a user's font size preference or preferred display name. An account may have multiple preferences. Preferences, and the pertaining request body, may contain any arbitrary JSON data that the user would like to store. **Permissions and scopes** To call this operation, you need permissions, based on the model you're using: - **Identity and access permissions**. Your user needs a role with these permissions. [Learn more](https://techdocs.akamai.com/cloud-computing/docs/identity-access-cm-available-roles). - Permissions: `update_user_preferences` - **OAuth scopes**. Your user needs these scopes assigned. [Learn more](https://techdocs.akamai.com/linode-api/reference/get-started#oauth). - Scopes: `account:read_write` - [Answer security questions](https://techdocs.akamai.com/linode-api/reference/post-security-questions.md): Adds security question responses for your user. You need to use exactly three unique questions. Previous responses are overwritten if answered, or they're reset to `null` if unanswered. > 📘 > > You need to answer these security questions before you can access the [Create a two factor secret](ref:post-tfa-enable) operation. **Permissions and scopes** To call this operation, you need permissions, based on the model you're using: - **Identity and access permissions**. Your user needs a role with these permissions. [Learn more](https://techdocs.akamai.com/cloud-computing/docs/identity-access-cm-available-roles). - Permissions: `answer_profile_security_questions` - **OAuth scopes**. Your user needs these scopes assigned. [Learn more](https://techdocs.akamai.com/linode-api/reference/get-started#oauth). - Scopes: `account:read_write` - [List security questions](https://techdocs.akamai.com/linode-api/reference/get-security-questions.md): Returns a collection of security questions and their responses, if any, for your User Profile. **Permissions and scopes** To call this operation, you need permissions, based on the model you're using: - **Identity and access permissions**. Your user needs a role with these permissions. [Learn more](https://techdocs.akamai.com/cloud-computing/docs/identity-access-cm-available-roles). - Permissions: `list_profile_security_questions` - **OAuth scopes**. Your user needs these scopes assigned. [Learn more](https://techdocs.akamai.com/linode-api/reference/get-started#oauth). - Scopes: `account:read_only` **CLI** ```shell linode-cli security-questions list ``` [Learn more](https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli) - [Add an SSH key](https://techdocs.akamai.com/linode-api/reference/post-add-ssh-key.md): Adds an SSH Key to your Account profile. **Permissions and scopes** To call this operation, you need permissions, based on the model you're using: - **Identity and access permissions**. Your user needs a role with these permissions. [Learn more](https://techdocs.akamai.com/cloud-computing/docs/identity-access-cm-available-roles). - Permissions: `create_profile_ssh_key` - **OAuth scopes**. Your user needs these scopes assigned. [Learn more](https://techdocs.akamai.com/linode-api/reference/get-started#oauth). - Scopes: `account:read_write` **CLI** ```shell linode-cli sshkeys create \ --label "My SSH Key" \ --ssh_key "ssh-rsa AAAA_valid_public_ssh_key_123456785== user@their-computer" ``` [Learn more](https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli) - [List SSH keys](https://techdocs.akamai.com/linode-api/reference/get-ssh-keys.md): Returns a collection of SSH Keys you've added to your Profile. **Permissions and scopes** To call this operation, you need permissions, based on the model you're using: - **Identity and access permissions**. Your user needs a role with these permissions. [Learn more](https://techdocs.akamai.com/cloud-computing/docs/identity-access-cm-available-roles). - Permissions: `list_profile_ssh_keys` - **OAuth scopes**. Your user needs these scopes assigned. [Learn more](https://techdocs.akamai.com/linode-api/reference/get-started#oauth). - Scopes: `account:read_only` **CLI** ```shell linode-cli sshkeys list ``` [Learn more](https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli) - [Get an SSH key](https://techdocs.akamai.com/linode-api/reference/get-ssh-key.md): Returns a single SSH Key object identified by `id` that you have access to view. **Permissions and scopes** To call this operation, you need permissions, based on the model you're using: - **Identity and access permissions**. Your user needs a role with these permissions. [Learn more](https://techdocs.akamai.com/cloud-computing/docs/identity-access-cm-available-roles). - Permissions: `view_profile_ssh_key` - **OAuth scopes**. Your user needs these scopes assigned. [Learn more](https://techdocs.akamai.com/linode-api/reference/get-started#oauth). - Scopes: `account:read_only` **CLI** ```shell linode-cli sshkeys view 42 ``` [Learn more](https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli) - [Update an SSH key](https://techdocs.akamai.com/linode-api/reference/put-ssh-key.md): Updates an SSH Key. Only SSH key labels can be updated. **Permissions and scopes** To call this operation, you need permissions, based on the model you're using: - **Identity and access permissions**. Your user needs a role with these permissions. [Learn more](https://techdocs.akamai.com/cloud-computing/docs/identity-access-cm-available-roles). - Permissions: `update_profile_ssh_key` - **OAuth scopes**. Your user needs these scopes assigned. [Learn more](https://techdocs.akamai.com/linode-api/reference/get-started#oauth). - Scopes: `account:read_write` **CLI** ```shell linode-cli sshkeys update 42 \ --label "my laptop" ``` [Learn more](https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli) - [Delete an SSH key](https://techdocs.akamai.com/linode-api/reference/delete-ssh-key.md): Deletes an SSH Key you have access to. > 📘 > > This operation only deletes a key's association from your profile. It doesn't remove it from any Linode or disk that was deployed with `authorized_keys`. You need to manually delete the key on the Linode or disk. **Permissions and scopes** To call this operation, you need permissions, based on the model you're using: - **Identity and access permissions**. Your user needs a role with these permissions. [Learn more](https://techdocs.akamai.com/cloud-computing/docs/identity-access-cm-available-roles). - Permissions: `delete_profile_ssh_key` - **OAuth scopes**. Your user needs these scopes assigned. [Learn more](https://techdocs.akamai.com/linode-api/reference/get-started#oauth). - Scopes: `account:read_write` **CLI** ```shell linode-cli sshkeys delete 42 ``` [Learn more](https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli) - [Create a two factor secret](https://techdocs.akamai.com/linode-api/reference/post-tfa-enable.md): Generates a secret key for your user. To enable two-factor authentication (2FA), enter this secret into your third-party authenticator application. To complete the 2FA setup, use the [Enable two-factor authentication](ref:post-tfa-confirm) operation to enter a one-time passcode (OTP) from your authenticator app. Once enabled, logins from untrusted computers are required to provide an OTP before they are successful. Run the [Answer security questions](ref:post-security-questions) operation. **Permissions and scopes** To call this operation, you need permissions, based on the model you're using: - **Identity and access permissions**. Your user needs a role with these permissions. [Learn more](https://techdocs.akamai.com/cloud-computing/docs/identity-access-cm-available-roles). - Permissions: `create_profile_tfa_secret` - **OAuth scopes**. Your user needs these scopes assigned. [Learn more](https://techdocs.akamai.com/linode-api/reference/get-started#oauth). - Scopes: `account:read_write` **CLI** ```shell linode-cli profile tfa-enable ``` [Learn more](https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli) - [Enable two factor authentication](https://techdocs.akamai.com/linode-api/reference/post-tfa-confirm.md): Confirms that you can successfully generate one-time codes. Once confirmed, 2FA is enabled on your account. Login attempts from untrusted computers will be required to provide a one-time code before they are successful. **Permissions and scopes** To call this operation, you need permissions, based on the model you're using: - **Identity and access permissions**. Your user needs a role with these permissions. [Learn more](https://techdocs.akamai.com/cloud-computing/docs/identity-access-cm-available-roles). - Permissions: `enable_profile_tfa` - **OAuth scopes**. Your user needs these scopes assigned. [Learn more](https://techdocs.akamai.com/linode-api/reference/get-started#oauth). - Scopes: `account:read_write` **CLI** ```shell linode-cli profile tfa-confirm \ --tfa_code 213456 ``` [Learn more](https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli) - [Disable two factor authentication](https://techdocs.akamai.com/linode-api/reference/post-tfa-disable.md): Disables two-factor authentication (2FA) for your user. Once successful, login attempts from untrusted computers will only require a password. Keep 2FA enabled to protect your account. **Permissions and scopes** To call this operation, you need permissions, based on the model you're using: - **Identity and access permissions**. Your user needs a role with these permissions. [Learn more](https://techdocs.akamai.com/cloud-computing/docs/identity-access-cm-available-roles). - Permissions: `disable_profile_tfa` - **OAuth scopes**. Your user needs these scopes assigned. [Learn more](https://techdocs.akamai.com/linode-api/reference/get-started#oauth). - Scopes: `account:read_write` **CLI** ```shell linode-cli profile tfa-disable ``` [Learn more](https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli) - [Create a personal access token](https://techdocs.akamai.com/linode-api/reference/post-personal-access-token.md): Creates a personal access token for your User. The raw token will be returned in the response, but will never be returned again afterward so be sure to take note of it. You may create a token with _at most_ the scopes of your current token. The created token will be able to access your account until the given expiry, or until it's revoked. __Parent and child accounts__ In the context of the [parent and child accounts](https://techdocs.akamai.com/cloud-computing/docs/parent-and-child-accounts-for-akamai-partners) feature, delegate users can't use personal access tokens on child accounts. You need to [create a delegate user token](ref:post-iam-delegation-profile-child-account-token) instead. **Permissions and scopes** To call this operation, you need permissions, based on the model you're using: - **Identity and access permissions**. Your user needs a role with these permissions. [Learn more](https://techdocs.akamai.com/cloud-computing/docs/identity-access-cm-available-roles). - Permissions: `create_profile_pat` - **OAuth scopes**. Your user needs these scopes assigned. [Learn more](https://techdocs.akamai.com/linode-api/reference/get-started#oauth). - Scopes: `account:read_write` **CLI** ```shell linode-cli profile token-create \ --scopes '*' \ --expiry '2018-01-01T13:46:32' \ --label linode-cli ``` [Learn more](https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli) - [List personal access tokens](https://techdocs.akamai.com/linode-api/reference/get-personal-access-tokens.md): Returns a paginated list of personal access tokens currently active for your user. **Permissions and scopes** To call this operation, you need permissions, based on the model you're using: - **Identity and access permissions**. Your user needs a role with these permissions. [Learn more](https://techdocs.akamai.com/cloud-computing/docs/identity-access-cm-available-roles). - Permissions: `list_profile_pats` - **OAuth scopes**. Your user needs these scopes assigned. [Learn more](https://techdocs.akamai.com/linode-api/reference/get-started#oauth). - Scopes: `account:read_only` **CLI** ```shell linode-cli profile tokens-list ``` [Learn more](https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli) - [Get a personal access token](https://techdocs.akamai.com/linode-api/reference/get-personal-access-token.md): Returns a single personal access token. **Permissions and scopes** To call this operation, you need permissions, based on the model you're using: - **Identity and access permissions**. Your user needs a role with these permissions. [Learn more](https://techdocs.akamai.com/cloud-computing/docs/identity-access-cm-available-roles). - Permissions: `view_profile_pat` - **OAuth scopes**. Your user needs these scopes assigned. [Learn more](https://techdocs.akamai.com/linode-api/reference/get-started#oauth). - Scopes: `account:read_only` **CLI** ```shell linode-cli profile token-view 123 ``` [Learn more](https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli) - [Update a personal access token](https://techdocs.akamai.com/linode-api/reference/put-personal-access-token.md): Updates a Personal Access Token. __Parent and child accounts__ In the context of the [parent and child accounts](https://techdocs.akamai.com/cloud-computing/docs/parent-and-child-accounts-for-akamai-partners) feature, delegate users can't use personal access tokens on child accounts. You need to [create a delegate user token](ref:post-iam-delegation-profile-child-account-token) instead. **Permissions and scopes** To call this operation, you need permissions, based on the model you're using: - **Identity and access permissions**. Your user needs a role with these permissions. [Learn more](https://techdocs.akamai.com/cloud-computing/docs/identity-access-cm-available-roles). - Permissions: `update_profile_pat` - **OAuth scopes**. Your user needs these scopes assigned. [Learn more](https://techdocs.akamai.com/linode-api/reference/get-started#oauth). - Scopes: `account:read_write` **CLI** ```shell linode-cli profile token-update 123 \ --label linode-cli ``` [Learn more](https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli) - [Revoke a personal access token](https://techdocs.akamai.com/linode-api/reference/delete-personal-access-token.md): Revokes a personal access token. The token will be invalidated immediately, and requests using that token will fail with a 401. It is possible to revoke access to the token making the request to revoke a token, but keep in mind that doing so could lose you access to the api and require you to create a new token through some other means. **Permissions and scopes** To call this operation, you need permissions, based on the model you're using: - **Identity and access permissions**. Your user needs a role with these permissions. [Learn more](https://techdocs.akamai.com/cloud-computing/docs/identity-access-cm-available-roles). - Permissions: `delete_profile_pat` - **OAuth scopes**. Your user needs these scopes assigned. [Learn more](https://techdocs.akamai.com/linode-api/reference/get-started#oauth). - Scopes: `account:read_write` **CLI** ```shell linode-cli profile token-delete 123 ``` [Learn more](https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli) - [List regions](https://techdocs.akamai.com/linode-api/reference/get-regions.md): Lists the regions available for Linode services. Not all services are guaranteed to be available in all regions. **CLI** ```shell linode-cli regions list ``` [Learn more](https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli) - [List regions' availability](https://techdocs.akamai.com/linode-api/reference/get-regions-availability.md): Returns availability data for all regions. **CLI** ```shell linode-cli regions list-avail ``` [Learn more](https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli) - [Get a region](https://techdocs.akamai.com/linode-api/reference/get-region.md): Returns a single Region. **CLI** ```shell linode-cli regions view us-east ``` [Learn more](https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli) - [Get a region's availability](https://techdocs.akamai.com/linode-api/reference/get-region-availability.md): Returns availability data for a single Region. **CLI** ```shell linode-cli regions view-avail us-east ``` [Learn more](https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli) - [Create a resource lock](https://techdocs.akamai.com/linode-api/reference/post-resource-lock.md): __Beta__ Create a lock for a resource, to help prevent you from inadvertently deleting it or modifying some aspects of it. You can apply a lock to a single resource, or to a resource and all of its sub-resources. This operation can only be accessed by account [users](ref:get-users) with _unrestricted_ access. Talk to your local account administrator about access management. Once a resource has a lock, that resource (and its sub-resources, if applicable) can't be deleted, regardless of your user permission. You can unlock a resource by running the [Delete a resource lock](ref:delete-resource-lock) operation for the specific lock. > 👍 There's a tutorial > > We offer an example API [workflow](ref:create-a-resource-lock-for-a-linode) you can follow to set up a resource lock on a Linode. **Permissions and scopes** To call this operation, you need the following: - **OAuth scopes**. Your user needs these scopes assigned. [Learn more](https://techdocs.akamai.com/linode-api/reference/get-started#oauth). - Scopes: `account:read_write` **CLI** ```shell linode-cli resource-locks create \ --entity_id 8642531 \ --entity_type linode \ --lock_type cannot_delete \ ``` [Learn more](https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli) - [List resource locks](https://techdocs.akamai.com/linode-api/reference/get-resource-locks.md): __Beta__ Returns all available locks and information on the resources they protect. This operation can only be accessed by account [users](ref:get-users) with _unrestricted_ access. Talk to your local account administrator about access management. **Permissions and scopes** To call this operation, you need the following: - **OAuth scopes**. Your user needs these scopes assigned. [Learn more](https://techdocs.akamai.com/linode-api/reference/get-started#oauth). - Scopes: `account:read_only` **CLI** ```shell linode-cli resource-locks list ``` [Learn more](https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli) - [Get a resource lock](https://techdocs.akamai.com/linode-api/reference/get-resource-lock.md): __Beta__ Returns a specific resource lock. This operation can only be accessed by account [users](ref:get-users) with _unrestricted_ access. Talk to your local account administrator about access management. **Permissions and scopes** To call this operation, you need the following: - **OAuth scopes**. Your user needs these scopes assigned. [Learn more](https://techdocs.akamai.com/linode-api/reference/get-started#oauth). - Scopes: `account:read_only` **CLI** ```shell linode-cli resource-locks view 25 ``` [Learn more](https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli) - [Delete a resource lock](https://techdocs.akamai.com/linode-api/reference/delete-resource-lock.md): __Beta__ Delete a specific resource lock. Once deleted, the resource it was assigned to is unlocked, and that resource can be deleted. This operation can only be accessed by account [users](ref:get-users) with _unrestricted_ access. Talk to your local account administrator about access management. > 📘 > > For specific delete instructions and requirements, see the relevant resource's delete operation documentation. **Permissions and scopes** To call this operation, you need the following: - **OAuth scopes**. Your user needs these scopes assigned. [Learn more](https://techdocs.akamai.com/linode-api/reference/get-started#oauth). - Scopes: `account:read_write` **CLI** ```shell linode-cli resource-locks delete 25 ``` [Learn more](https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli) - [Open a support ticket](https://techdocs.akamai.com/linode-api/reference/post-ticket.md): Open a support ticket. A ticket can only target a single, specific entity. For example, for an issue with a specific Linode, open a ticket and target it using its `linode_id`. Leave all other entities out of the request or set them to `null`. **Permissions and scopes** To call this operation, you need permissions, based on the model you're using: - **OAuth scopes**. Your user needs these scopes assigned. [Learn more](https://techdocs.akamai.com/linode-api/reference/get-started#oauth). - Scopes: `account:read_write` **CLI** ```shell linode-cli tickets create \ --description "I'm having trouble setting the root password on my Linode. I tried following the instructions but something is not working and I'm not sure what I'm doing wrong. Can you please help me figure out how I can reset it?" \ --linode_id 123 \ --summary "Having trouble resetting root password on my Linode" ``` [Learn more](https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli) - [List support tickets](https://techdocs.akamai.com/linode-api/reference/get-tickets.md): Returns a collection of all support tickets opened from your account. This includes tickets you've opened and tickets generated by Linode customer support regarding your account. Open tickets are returned first in the response. **Permissions and scopes** To call this operation, you need permissions, based on the model you're using: - **OAuth scopes**. Your user needs these scopes assigned. [Learn more](https://techdocs.akamai.com/linode-api/reference/get-started#oauth). - Scopes: `account:read_only` **CLI** ```shell linode-cli tickets list ``` [Learn more](https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli) - [Get a support ticket](https://techdocs.akamai.com/linode-api/reference/get-ticket.md): Returns a specific support ticket under your account. **Permissions and scopes** To call this operation, you need permissions, based on the model you're using: - **OAuth scopes**. Your user needs these scopes assigned. [Learn more](https://techdocs.akamai.com/linode-api/reference/get-started#oauth). - Scopes: `account:read_only` **CLI** ```shell linode-cli tickets view 11223344 ``` [Learn more](https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli) - [Close a support ticket](https://techdocs.akamai.com/linode-api/reference/post-close-ticket.md): Closes a support ticket you have access to modify. **Permissions and scopes** To call this operation, you need permissions, based on the model you're using: - **OAuth scopes**. Your user needs these scopes assigned. [Learn more](https://techdocs.akamai.com/linode-api/reference/get-started#oauth). - Scopes: `account:read_write` **CLI** ```shell linode-cli tickets close 11223344 ``` [Learn more](https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli) - [Create a support ticket attachment](https://techdocs.akamai.com/linode-api/reference/post-ticket-attachment.md): Adds a file attachment to an open support ticket on your account. Use an attachment to help customer support resolve your ticket. The file attachment is submitted in the request as `multipart/form-data` type. Accepted file extensions include: `.gif`, `.jpg`, `.jpeg`, `.pjpg`, `.pjpeg`, `.tif`, `.tiff`, `.png`, `.pdf`, or `.txt`. **Permissions and scopes** To call this operation, you need permissions, based on the model you're using: - **OAuth scopes**. Your user needs these scopes assigned. [Learn more](https://techdocs.akamai.com/linode-api/reference/get-started#oauth). - Scopes: `account:read_write` - [Create a reply](https://techdocs.akamai.com/linode-api/reference/post-ticket-reply.md): Adds a reply to an existing support ticket. **Permissions and scopes** To call this operation, you need permissions, based on the model you're using: - **OAuth scopes**. Your user needs these scopes assigned. [Learn more](https://techdocs.akamai.com/linode-api/reference/get-started#oauth). - Scopes: `account:read_write` **CLI** ```shell linode-cli tickets reply 11223344 \ --description "Thank you for your help. I was able to figure out what the problem was and I successfully reset my password. You guys are the best!" ``` [Learn more](https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli) - [List replies](https://techdocs.akamai.com/linode-api/reference/get-ticket-replies.md): Returns a collection of replies to a support ticket on your account. **Permissions and scopes** To call this operation, you need permissions, based on the model you're using: - **OAuth scopes**. Your user needs these scopes assigned. [Learn more](https://techdocs.akamai.com/linode-api/reference/get-started#oauth). - Scopes: `account:read_only` **CLI** ```shell linode-cli tickets replies 11223344 ``` [Learn more](https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli) - [Create a tag](https://techdocs.akamai.com/linode-api/reference/post-tag.md): Creates a new tag and lets you optionally add it to specific objects. Tags are labels you can attach to objects in your account. Use them to specify and group attributes of objects that are relevant to you. Currently, you can add a tag to your `linodes`, your `nodebalancers`, your `reserved_ipv4_addresses`, the `domains` for your Linodes, and the `volumes` on your Linodes. > 📘 > > - This operation can only be accessed by account users with _unrestricted_ access. Talk to your local account administrator about access management. > > - If you don't add a tag to a supported object with this operation, you can use that object's update operation to later add the tag you created. **Permissions and scopes** To call this operation, you need permissions, based on the model you're using: - **OAuth scopes**. Your user needs these scopes assigned. [Learn more](https://techdocs.akamai.com/linode-api/reference/get-started#oauth). - Scopes: `account:read_write` **CLI** ```shell linode-cli tags create \ --label 'example tag' \ --linodes 123 \ --linodes 456 \ --volumes 9082 \ --volumes 10003 \ --reserved_ipv4_addresses "192.0.2.141" ``` [Learn more](https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli) - [List tags](https://techdocs.akamai.com/linode-api/reference/get-tags.md): Returns a paginated list of tags you've [created](ref:post-tag) on your account. This operation can only be accessed by account users with _unrestricted_ access. Talk to your local account administrator about access management. **Permissions and scopes** To call this operation, you need permissions, based on the model you're using: - **OAuth scopes**. Your user needs these scopes assigned. [Learn more](https://techdocs.akamai.com/linode-api/reference/get-started#oauth). - Scopes: `account:read_only` **CLI** ```shell linode-cli tags list linode-cli tags ls ``` [Learn more](https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli) - [List tagged objects](https://techdocs.akamai.com/linode-api/reference/get-tagged-objects.md): Returns a paginated list of all objects you've tagged with the specified tag. The response includes a mixed collection of all object types. This operation can only be accessed by account users with _unrestricted_ access. Talk to your local account administrator about access management. **Permissions and scopes** To call this operation, you need permissions, based on the model you're using: - **OAuth scopes**. Your user needs these scopes assigned. [Learn more](https://techdocs.akamai.com/linode-api/reference/get-started#oauth). - Scopes: `account:read_only` - [Delete a tag](https://techdocs.akamai.com/linode-api/reference/delete-tag.md): Deletes the tag and removes it from all tagged objects and reserved IPs. This doesn't delete the objects or reserved IPs. This operation can only be accessed by account users with _unrestricted_ access. Talk to your local account administrator about access management. > 📘 > > Tags without any related objects are periodically cleaned up by the system. **Permissions and scopes** To call this operation, you need permissions, based on the model you're using: - **OAuth scopes**. Your user needs these scopes assigned. [Learn more](https://techdocs.akamai.com/linode-api/reference/get-started#oauth). - Scopes: `account:read_write` **CLI** ```shell linode-cli tags delete linode-cli tags rm ``` [Learn more](https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli) - [Create a volume](https://techdocs.akamai.com/linode-api/reference/post-volume.md): Creates a [Block Storage](https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-block-storage) volume on your account. Creating a new volume accrues additional charges on your account. **Permissions and scopes** To call this operation, you need the following: - **Identity and access permissions**. Your user needs a role with these permissions assigned. [Learn more](https://techdocs.akamai.com/cloud-computing/docs/identity-access-cm-available-roles). - Permissions: `create_volume` - **OAuth scopes**. Your user needs these scopes assigned. [Learn more](https://techdocs.akamai.com/linode-api/reference/get-started#oauth). - Scopes: `volumes:read_write` **CLI** ```shell linode-cli volumes create \ --label my-volume \ --size 20 \ --linode_id 12346 \ --no-defaults ``` [Learn more](https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli) - [List volumes](https://techdocs.akamai.com/linode-api/reference/get-volumes.md): Returns a paginated list of the Block Storage volumes that you have permission to view. **Permissions and scopes** To call this operation, you need the following: - **Identity and access permissions**. Your user needs a role with these permissions assigned. [Learn more](https://techdocs.akamai.com/cloud-computing/docs/identity-access-cm-available-roles). - Permissions: `view_volume` - **OAuth scopes**. Your user needs these scopes assigned. [Learn more](https://techdocs.akamai.com/linode-api/reference/get-started#oauth). - Scopes: `volumes:read_only` **CLI** ```shell linode-cli volumes list ``` [Learn more](https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli) - [Get a volume](https://techdocs.akamai.com/linode-api/reference/get-volume.md): Get information about a specific Block Storage volume. **Permissions and scopes** To call this operation, you need the following: - **Identity and access permissions**. Your user needs a role with these permissions assigned. [Learn more](https://techdocs.akamai.com/cloud-computing/docs/identity-access-cm-available-roles). - Permissions: `view_volume` - **OAuth scopes**. Your user needs these scopes assigned. [Learn more](https://techdocs.akamai.com/linode-api/reference/get-started#oauth). - Scopes: `volumes:read_only` **CLI** ```shell linode-cli volumes view 12345 ``` [Learn more](https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli) - [Update a volume](https://techdocs.akamai.com/linode-api/reference/put-volume.md): Update a specific Block Storage volume. **Permissions and scopes** To call this operation, you need the following: - **Identity and access permissions**. Your user needs a role with these permissions assigned. [Learn more](https://techdocs.akamai.com/cloud-computing/docs/identity-access-cm-available-roles). - Permissions: `update_volume` - **OAuth scopes**. Your user needs these scopes assigned. [Learn more](https://techdocs.akamai.com/linode-api/reference/get-started#oauth). - Scopes: `volumes:read_write` **CLI** ```shell linode-cli volumes update 12345 \ --label my_volume ``` [Learn more](https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli) - [Delete a volume](https://techdocs.akamai.com/linode-api/reference/delete-volume.md): Delete a Block Storage volume. Some conditions apply when deleting a volume: - Deleting a volume can't be undone. - Deleting stops billing for the volume. You'll be billed for the time the volume was active during the current billing period. - You can't delete a volume that's attached to a Linode currently being [migrated](ref:post-migrate-linode-instance). You need to wait for the migration to complete. - You can't delete a volume that has a `cannot_delete` or `cannot_delete_with_subresources` [resource lock](ref:post-resource-lock) set for it. **Permissions and scopes** To call this operation, you need the following: - **Identity and access permissions**. Your user needs a role with these permissions assigned. [Learn more](https://techdocs.akamai.com/cloud-computing/docs/identity-access-cm-available-roles). - Permissions: `delete_volume` - **OAuth scopes**. Your user needs these scopes assigned. [Learn more](https://techdocs.akamai.com/linode-api/reference/get-started#oauth). - Scopes: `volumes:read_write` **CLI** ```shell linode-cli volumes delete 12345 ``` [Learn more](https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli) - [Attach a volume](https://techdocs.akamai.com/linode-api/reference/post-attach-volume.md): Attach a Block Storage volume to an existing Linode. > 📘 > > - The volume and its target Linode need to exist in the same `region`. You can run the [List volumes](ref:get-volumes) and [List Linodes](ref:get-linode-instances) operations and review the `region` for each. > > - There's a maximum number of volumes that can be attached to a single Linode configuration. This number varies, based on the Linode's plan, with higher plan types supporting more volumes. The maximum follows a formula of the Linode plan's `total_ram / 1024`, with a minimum of 8 and a total maximum of 64 volumes. Rescue configurations support a maximum of 8. **Permissions and scopes** To call this operation, you need the following: - **Identity and access permissions**. Your user needs a role with these permissions assigned. [Learn more](https://techdocs.akamai.com/cloud-computing/docs/identity-access-cm-available-roles). - Permissions: `attach_volume` - **OAuth scopes**. Your user needs these scopes assigned. [Learn more](https://techdocs.akamai.com/linode-api/reference/get-started#oauth). - Scopes: `volumes:read_write, linodes:read_write` **CLI** ```shell linode-cli volumes attach 12345 \ --linode_id 12346 \ --config_id 23456 ``` [Learn more](https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli) - [Clone a volume](https://techdocs.akamai.com/linode-api/reference/post-clone-volume.md): Target an existing Block Storage volume to create a new one. The resulting volume will be the same size and include the same data. A new volume will incur a charge on your account. > 📘 > > Only a volume with a `status` of `active` can be cloned. Run the [List volumes](ref:get-volumes) operation to view the `status` of each of your volumes. **Permissions and scopes** To call this operation, you need the following: - **Identity and access permissions**. Your user needs a role with these permissions assigned. [Learn more](https://techdocs.akamai.com/cloud-computing/docs/identity-access-cm-available-roles). - Permissions: `clone_volume` - **OAuth scopes**. Your user needs these scopes assigned. [Learn more](https://techdocs.akamai.com/linode-api/reference/get-started#oauth). - Scopes: `volumes:read_write` **CLI** ```shell linode-cli volumes clone 12345 \ --label my-volume ``` [Learn more](https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli) - [Detach a volume](https://techdocs.akamai.com/linode-api/reference/post-detach-volume.md): Detach a Block Storage volume from a Linode. When you [delete](ref:delete-linode-instance) a Linode, any volumes attached to it are automatically detached. **Permissions and scopes** To call this operation, you need the following: - **Identity and access permissions**. Your user needs a role with these permissions assigned. [Learn more](https://techdocs.akamai.com/cloud-computing/docs/identity-access-cm-available-roles). - Permissions: `detach_volume` - **OAuth scopes**. Your user needs these scopes assigned. [Learn more](https://techdocs.akamai.com/linode-api/reference/get-started#oauth). - Scopes: `volumes:read_write, linodes:read_write` **CLI** ```shell linode-cli volumes detach 12345 ``` [Learn more](https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli) - [Resize a volume](https://techdocs.akamai.com/linode-api/reference/post-resize-volume.md): Increase the size of an existing Block Storage volume on your account. > 📘 > > - You can't decrease the size of an existing volume. > > - Only a volume with a `status` of `active` can be resized. Run the [List volumes](ref:get-volumes) operation to view the `status` of each of your volumes. **Permissions and scopes** To call this operation, you need the following: - **Identity and access permissions**. Your user needs a role with these permissions assigned. [Learn more](https://techdocs.akamai.com/cloud-computing/docs/identity-access-cm-available-roles). - Permissions: `resize_volume` - **OAuth scopes**. Your user needs these scopes assigned. [Learn more](https://techdocs.akamai.com/linode-api/reference/get-started#oauth). - Scopes: `volumes:read_write` **CLI** ```shell linode-cli volumes resize 12345 \ --size 30 ``` [Learn more](https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli) - [List volume types](https://techdocs.akamai.com/linode-api/reference/get-volume-types.md): Returns Block Storage volume types and prices, including any region-specific rates. **Permissions and scopes** To call this operation, you need the following: - **Identity and access permissions**. This operation is internet-facing. No permissions are required. **CLI** ```shell linode-cli volumes types ``` [Learn more](https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli) - [Create a VPC](https://techdocs.akamai.com/linode-api/reference/post-vpc.md): Create a new VPC and optionally associated VPC Subnets. A successful request triggers a `vpc_create` event and `subnet_create` events for any created VPC Subnets. After you create a VPC, you can attach it to a Linode by assigning a VPC subnet to one of the Linode's network interfaces. To do this, you can run the following operations: - [Create a Linode](ref:post-linode-instance) - [Create a config profile](ref:post-add-linode-config) - [Update a config profile](ref:put-linode-config) - [Add a configuration profile interface](ref:post-linode-config-interface) You can also attach managed databases and NodeBalancers to a subnet. **Permissions and scopes** To call this operation, you need permissions, based on the model you're using: - **Identity and access permissions**. Your user needs a role with these permissions. [Learn more](https://techdocs.akamai.com/cloud-computing/docs/identity-access-cm-available-roles). - Permissions: `create_vpc` - **OAuth scopes**. Your user needs these scopes assigned. [Learn more](https://techdocs.akamai.com/linode-api/reference/get-started#oauth). - Scopes: `vpc:read_write` **CLI** ```shell linode-cli vpcs create \ --description "A description of my VPC." \ --label cool-vpc \ --region us-east \ --subnets.label cool-vpc-subnet \ --subnets.ipv4 10.0.1.0/24 ``` [Learn more](https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli) - [List VPCs](https://techdocs.akamai.com/linode-api/reference/get-vpcs.md): Display all VPCs on your account. **Permissions and scopes** To call this operation, you need permissions, based on the model you're using: - **Identity and access permissions**. Your user needs a role with these permissions. [Learn more](https://techdocs.akamai.com/cloud-computing/docs/identity-access-cm-available-roles). - Permissions: `view_vpc` **CLI** ```shell linode-cli vpcs list ``` [Learn more](https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli) - [Get a VPC](https://techdocs.akamai.com/linode-api/reference/get-vpc.md): Get information about a single VPC. **Permissions and scopes** To call this operation, you need permissions, based on the model you're using: - **Identity and access permissions**. Your user needs a role with these permissions. [Learn more](https://techdocs.akamai.com/cloud-computing/docs/identity-access-cm-available-roles). - Permissions: `view_vpc` **CLI** ```shell linode-cli vpcs view $vpcId ``` [Learn more](https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli) - [Update a VPC](https://techdocs.akamai.com/linode-api/reference/put-vpc.md): Update an existing VPC. A successful request triggers a `vpc_update` event. To update a VPC's Subnet, run the [Update a VPC subnet](ref:put-vpc-subnet) operation. **Permissions and scopes** To call this operation, you need permissions, based on the model you're using: - **Identity and access permissions**. Your user needs a role with these permissions. [Learn more](https://techdocs.akamai.com/cloud-computing/docs/identity-access-cm-available-roles). - Permissions: `update_vpc` - **OAuth scopes**. Your user needs these scopes assigned. [Learn more](https://techdocs.akamai.com/linode-api/reference/get-started#oauth). - Scopes: `vpc:read_write` **CLI** ```shell linode-cli vpcs update $vpcId \ --description "A description of my VPC." --label cool-vpc ``` [Learn more](https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli) - [Delete a VPC](https://techdocs.akamai.com/linode-api/reference/delete-vpc.md): Delete a single VPC and all of its Subnets. - A successful request triggers a `vpc_delete` event and `subnet_delete` events for each deleted VPC Subnet. - All of the VPC's subnets need to be eligible for deletion. You need to delete all network interfaces each subnet is assigned to. If those interfaces are active, you need to shut down the associated Linodes first. If any subnet can't be deleted, it prevents the VPC and its subnets from being deleted. - You can't delete a VPC if a NodeBalancer or a managed database is attached to one of its subnets. **Permissions and scopes** To call this operation, you need permissions, based on the model you're using: - **Identity and access permissions**. Your user needs a role with these permissions. [Learn more](https://techdocs.akamai.com/cloud-computing/docs/identity-access-cm-available-roles). - Permissions: `delete_vpc` - **OAuth scopes**. Your user needs these scopes assigned. [Learn more](https://techdocs.akamai.com/linode-api/reference/get-started#oauth). - Scopes: `vpc:read_write` **CLI** ```shell linode-cli vpcs delete $vpcId ``` [Learn more](https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli) - [List VPC IP addresses](https://techdocs.akamai.com/linode-api/reference/get-vpcs-ips.md): Returns a paginated list of all VPC IP addresses and address ranges on your account. > 📘 > > If a Linode has several configuration profiles that include a VPC interface, address information for all of them is listed in the response. Since VPCs can use the same address space, you may see duplicate IP addresses. **Permissions and scopes** To call this operation, you need permissions, based on the model you're using: - **Identity and access permissions**. Your user needs a role with these permissions. [Learn more](https://techdocs.akamai.com/cloud-computing/docs/identity-access-cm-available-roles). - Permissions: `list_vpcs_ip_addresses` - **OAuth scopes**. Your user needs these scopes assigned. [Learn more](https://techdocs.akamai.com/linode-api/reference/get-started#oauth). - Scopes: `ips:read_only` **CLI** ```shell linode-cli vpcs ips-all-list ``` [Learn more](https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli) - [List a VPC's IP addresses](https://techdocs.akamai.com/linode-api/reference/get-vpc-ips.md): Returns a paginated list of IP addresses for a single VPC. **Permissions and scopes** To call this operation, you need permissions, based on the model you're using: - **Identity and access permissions**. Your user needs a role with these permissions. [Learn more](https://techdocs.akamai.com/cloud-computing/docs/identity-access-cm-available-roles). - Permissions: `list_vpc_ip_addresses` - **OAuth scopes**. Your user needs these scopes assigned. [Learn more](https://techdocs.akamai.com/linode-api/reference/get-started#oauth). - Scopes: `ips:read_only` **CLI** ```shell linode-cli vpcs ip-list 123 ``` [Learn more](https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli) - [Create a VPC subnet](https://techdocs.akamai.com/linode-api/reference/post-vpc-subnet.md): Create a VPC Subnet. A successful request triggers a `subnet_create` event. After you create a VPC subnet, you can attach it to a Linode by assigning the subnet to one of the Linode's network interfaces. To do this, you can run the following operations: - [Create a Linode](ref:post-linode-instance) - [Create a config profile](ref:post-add-linode-config) - [Update a config profile](ref:put-linode-config) - [Add a configuration profile interface](ref:post-linode-config-interface) You can also attach managed databases and NodeBalancers to a subnet. **Permissions and scopes** To call this operation, you need permissions, based on the model you're using: - **Identity and access permissions**. Your user needs a role with these permissions. [Learn more](https://techdocs.akamai.com/cloud-computing/docs/identity-access-cm-available-roles). - Permissions: `create_vpc_subnet` - **OAuth scopes**. Your user needs these scopes assigned. [Learn more](https://techdocs.akamai.com/linode-api/reference/get-started#oauth). - Scopes: `vpc:read_write` **CLI** ```shell linode-cli vpcs subnet-create $vpcId \ --label cool-vpc-subnet \ --ipv4 10.0.1.0/24 ``` [Learn more](https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli) - [List VPC subnets](https://techdocs.akamai.com/linode-api/reference/get-vpc-subnets.md): Get information about all VPC Subnets associated with a VPC. **Permissions and scopes** To call this operation, you need permissions, based on the model you're using: - **Identity and access permissions**. Your user needs a role with these permissions. [Learn more](https://techdocs.akamai.com/cloud-computing/docs/identity-access-cm-available-roles). - Permissions: `view_vpc_subnets` **CLI** ```shell linode-cli vpcs subnets-list $vpcId ``` [Learn more](https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli) - [Get a VPC subnet](https://techdocs.akamai.com/linode-api/reference/get-vpc-subnet.md): Get information about a single VPC Subnet. **Permissions and scopes** To call this operation, you need permissions, based on the model you're using: - **Identity and access permissions**. Your user needs a role with these permissions. [Learn more](https://techdocs.akamai.com/cloud-computing/docs/identity-access-cm-available-roles). - Permissions: `view_vpc_subnet` **CLI** ```shell linode-cli vpcs subnet-view $vpcId $vpcSubnetId ``` [Learn more](https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli) - [Update a VPC subnet](https://techdocs.akamai.com/linode-api/reference/put-vpc-subnet.md): Update a VPC Subnet. A successful request triggers a `subnet_update` event. **Permissions and scopes** To call this operation, you need permissions, based on the model you're using: - **Identity and access permissions**. Your user needs a role with these permissions. [Learn more](https://techdocs.akamai.com/cloud-computing/docs/identity-access-cm-available-roles). - Permissions: `update_vpc_subnet` - **OAuth scopes**. Your user needs these scopes assigned. [Learn more](https://techdocs.akamai.com/linode-api/reference/get-started#oauth). - Scopes: `vpc:read_write` **CLI** ```shell linode-cli vpcs subnet-update $vpcId \ --label cool-vpc-subnet ``` [Learn more](https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli) - [Delete a VPC subnet](https://techdocs.akamai.com/linode-api/reference/delete-vpc-subnet.md): Delete a single VPC subnet. A successful request triggers a `subnet_delete` event. > 📘 > > You need to delete all network interfaces, managed databases and NodeBalancers that this subnet is assigned to before you can delete it. If interfaces are active, the associated Linode needs to be shut down before they can be removed. For more information see: > > - [Delete a Linode interface](ref:delete-linode-interface) and [Delete a configuration profile interface](ref:delete-linode-config-interface) > - [Delete a MySQL Managed Database](ref:delete-databases-mysql-instance) and [Delete a PostgreSQL Managed Database](ref:delete-databases-postgre-sql-instance) > - [Delete a NodeBalancer](ref:delete-node-balancer) **Permissions and scopes** To call this operation, you need permissions, based on the model you're using: - **Identity and access permissions**. Your user needs a role with these permissions. [Learn more](https://techdocs.akamai.com/cloud-computing/docs/identity-access-cm-available-roles). - Permissions: `delete_vpc_subnet` - **OAuth scopes**. Your user needs these scopes assigned. [Learn more](https://techdocs.akamai.com/linode-api/reference/get-started#oauth). - Scopes: `vpc:read_write` **CLI** ```shell linode-cli vpcs subnet-delete $vpcId $vpcSubnetId ``` [Learn more](https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli) ## Changelog - [July 1, 2026 — Reserved Public IPv4 Addresses](https://techdocs.akamai.com/linode-api/changelog/july-1-2026.md) - [Jun 30, 2026 — ACLP - Metrics updates](https://techdocs.akamai.com/linode-api/changelog/jun-30-2026-aclp-metrics-updates.md) - [Jun 5, 2026 — ACLP - Alerts updates](https://techdocs.akamai.com/linode-api/changelog/jun-5-2026-aclp-alerts-updates.md) - [Jun 3, 2026 — Password-less Linode support](https://techdocs.akamai.com/linode-api/changelog/jun-3-2026-password-less-linode-support.md) - [May 21, 2026 — ACLP Alerts is LA](https://techdocs.akamai.com/linode-api/changelog/may-21-2026-aclp-alerts-is-la.md) # mPulse Documentation > mPulse is ​Akamai​'s real user measurement solution that maps user behavior to business performance as it's happening. With mPulse you can collect detailed business and performance data directly from your users' browser or mobile application in real time, and then drill down for a closer look at the performance of all your resources across all of your page views to identify the root cause of latencies and lost revenue. ## Guides - [Welcome to mPulse](https://techdocs.akamai.com/mpulse/docs/welcome-to-mpulse.md) - [How mPulse works](https://techdocs.akamai.com/mpulse/docs/how-mpulse-works.md) - [Key concepts and terms](https://techdocs.akamai.com/mpulse/docs/key-concepts-terms.md) - [Third-party updates](https://techdocs.akamai.com/mpulse/docs/third-party-updates.md) - [What's new?](https://techdocs.akamai.com/mpulse/docs/mpulse-new-ui.md) - [Get started](https://techdocs.akamai.com/mpulse/docs/get-started-1.md) - [Alerts](https://techdocs.akamai.com/mpulse/docs/mpulse-alerts.md) - [Dashboard and widget sharing](https://techdocs.akamai.com/mpulse/docs/dashboard-and-widget-sharing.md) - [Filter templates](https://techdocs.akamai.com/mpulse/docs/filter-templates.md) - [Waterfall](https://techdocs.akamai.com/mpulse/docs/waterfall.md) - [Quick start](https://techdocs.akamai.com/mpulse/docs/quick-start.md) - [About mPulse edge injection](https://techdocs.akamai.com/mpulse/docs/about-edge-injection.md) - [Set up mPulse at the origin](https://techdocs.akamai.com/mpulse/docs/set-up-behavior-options.md) - [Data privacy and user consent](https://techdocs.akamai.com/mpulse/docs/data-privacy-and-user-consent.md) - [Move mPulse from the origin to the edge](https://techdocs.akamai.com/mpulse/docs/move-mpulse-from-the-origin-to-the-edge.md) - [Explore mPulse](https://techdocs.akamai.com/mpulse/docs/explore-mpulse.md) - [Additional support and information](https://techdocs.akamai.com/mpulse/docs/additional-support-information.md) - [Set up an A/B test](https://techdocs.akamai.com/mpulse/docs/set-up-ab-test.md) - [Exclude data coming from internal sources](https://techdocs.akamai.com/mpulse/docs/exclude-data-internal-sources.md) - [Set up a single page application](https://techdocs.akamai.com/mpulse/docs/set-up-single-page-application.md) - [Measure your end users' bandwidth](https://techdocs.akamai.com/mpulse/docs/measure-end-users-bandwidth.md) - [Send beacons from JavaScript to mPulse](https://techdocs.akamai.com/mpulse/docs/send-beacons-js-mpulse.md) - [Send beacons manually](https://techdocs.akamai.com/mpulse/docs/send-beacons-manually.md) - [Get the most from your mPulse beacon](https://techdocs.akamai.com/mpulse/docs/most-mpulse-beacon.md) - [Use session tracking to manage visitor requests](https://techdocs.akamai.com/mpulse/docs/manage-visitor-requests.md): Configure how mPulse tracks sessions, and optionally track sessions across domains. - [Use page groups to isolate performance issues](https://techdocs.akamai.com/mpulse/docs/isolate-performance-issues.md) - [Use metrics and timers to understand how performance impacts your business](https://techdocs.akamai.com/mpulse/docs/use-metrics.md) - [Create a Lite app in an Enterprise tenant](https://techdocs.akamai.com/mpulse/docs/create-lite-app.md) - [Explore mPulse system dashboards and widgets](https://techdocs.akamai.com/mpulse/docs/explore-mpulse-system-dashboards-and-widgets.md) - [Get the big picture](https://techdocs.akamai.com/mpulse/docs/big-picture.md) - [Meet your business goals](https://techdocs.akamai.com/mpulse/docs/meet-business-goals.md) - [Find ways to boost performance](https://techdocs.akamai.com/mpulse/docs/boost-performance.md) - [Tour the globe](https://techdocs.akamai.com/mpulse/docs/tour-globe.md) - [Get a bird's-eye view of your users' experience](https://techdocs.akamai.com/mpulse/docs/view-users-experience.md) - [Check your site's pulse](https://techdocs.akamai.com/mpulse/docs/get-site-pulse.md) - [Optimize for browsers and devices](https://techdocs.akamai.com/mpulse/docs/optimize-browsers-devices.md) - [Analyze how a resource performs over time](https://techdocs.akamai.com/mpulse/docs/analyze-resource-performance.md) - [Analyze how external resources impact your business metrics](https://techdocs.akamai.com/mpulse/docs/analyze-external-resources.md) - [Forecast revenue, conversion, and degradation](https://techdocs.akamai.com/mpulse/docs/forecast-revenue-conversion-degradation.md) - [Fix performance issues](https://techdocs.akamai.com/mpulse/docs/fix-performance-issues.md) - [See how performance impacts traffic](https://techdocs.akamai.com/mpulse/docs/performance-impacts-traffic.md) - [Troubleshoot and fix domain errors](https://techdocs.akamai.com/mpulse/docs/troubleshoot-domain-errors.md) - [Take it to the top](https://techdocs.akamai.com/mpulse/docs/to-the-top.md) - [Clone a system dashboard](https://techdocs.akamai.com/mpulse/docs/clone-system-dashboard.md) - [Create a custom dashboard](https://techdocs.akamai.com/mpulse/docs/create-custom-dashboard.md) - [View custom dashboard settings](https://techdocs.akamai.com/mpulse/docs/custom-dashboard-settings.md) - [Add a dashboard container](https://techdocs.akamai.com/mpulse/docs/add-dashboard-container.md) - [Share a dashboard](https://techdocs.akamai.com/mpulse/docs/share-dashboard.md) - [Change the default dashboard](https://techdocs.akamai.com/mpulse/docs/change-default-dashboard.md) - [View widget settings](https://techdocs.akamai.com/mpulse/docs/view-widget-settings.md) - [Change widget settings](https://techdocs.akamai.com/mpulse/docs/change-widget-settings.md) - [Compare widget results](https://techdocs.akamai.com/mpulse/docs/compare-widget-results.md) - [Copy a widget](https://techdocs.akamai.com/mpulse/docs/copy-widget.md) - [Expand a widget](https://techdocs.akamai.com/mpulse/docs/expand-widget.md) - [Open a widget in a new window](https://techdocs.akamai.com/mpulse/docs/widget-new-window.md) - [Remove a widget](https://techdocs.akamai.com/mpulse/docs/remove-widget.md) - [Reposition a widget](https://techdocs.akamai.com/mpulse/docs/reposition-widget.md) - [Integrate widget charts and layouts](https://techdocs.akamai.com/mpulse/docs/integrate-widget-charts.md) - [Note changes in your site's performance](https://techdocs.akamai.com/mpulse/docs/changes-site-performance.md) - [About mPulse alerts](https://techdocs.akamai.com/mpulse/docs/about-mpulse-alerts.md) - [About mPulse reports](https://techdocs.akamai.com/mpulse/docs/about-mpulse-reports.md) - [Create a new mPulse user](https://techdocs.akamai.com/mpulse/docs/create-new-user.md) - [Create a new user group](https://techdocs.akamai.com/mpulse/docs/create-new-user-group.md) - [Assign user privileges](https://techdocs.akamai.com/mpulse/docs/assign-user-privileges.md) - [Add or change user permissions](https://techdocs.akamai.com/mpulse/docs/user-permissions.md) - [Change ownership](https://techdocs.akamai.com/mpulse/docs/change-ownership.md) - [Turn off concurrent logins](https://techdocs.akamai.com/mpulse/docs/turn-off-concurrent-logins.md) - [Monitor application performance](https://techdocs.akamai.com/mpulse/docs/monitor-application-performance.md) - [Create an external data source](https://techdocs.akamai.com/mpulse/docs/create-external-data-source.md) - [Set up Dynatrace Metrics](https://techdocs.akamai.com/mpulse/docs/dynatrace-metrics.md) - [Add an external data source widget to your dashboard](https://techdocs.akamai.com/mpulse/docs/external-data-source-widget-dashboard.md) - [Set your time zone and locale](https://techdocs.akamai.com/mpulse/docs/time-zone-locale.md) - [Set your company's time zone and locale](https://techdocs.akamai.com/mpulse/docs/company-time-zone.md) - [View your mPulse timeline events](https://techdocs.akamai.com/mpulse/docs/view-your-mpulse-timeline-events.md) - [Manage your mPulse environment with boomerang self-service](https://techdocs.akamai.com/mpulse/docs/manage-your-mpulse-environment-with-boomerang-self-service.md) - [Upgrade or change a boomerang version](https://techdocs.akamai.com/mpulse/docs/change-boomerang-version.md) - [Apply a boomerang version to your mPulse app](https://techdocs.akamai.com/mpulse/docs/apply-boomerang-version.md) - [Apply a default boomerang version for your company](https://techdocs.akamai.com/mpulse/docs/default-boomerang-version.md) - [Boomerang flavors](https://techdocs.akamai.com/mpulse/docs/boomerang-flavors.md) - [AMP Page mPulse integration](https://techdocs.akamai.com/mpulse/docs/amp-page-mpulse-integration.md) - [Real user monitoring (classic) reports replaced by mPulse dashboards](https://techdocs.akamai.com/mpulse/docs/real-user-monitoring-rum-reports-replaced-by-mpulse-dashboards.md) - [Migrating from Julia 0.4 to Julia 1.6](https://techdocs.akamai.com/mpulse/docs/migrating-from-julia-04-to-julia-16.md) ## API Reference - [mPulse API](https://techdocs.akamai.com/mpulse/reference/api.md) - [mPulse Beacons](https://techdocs.akamai.com/mpulse/reference/beacons.md) - [mPulse Queries](https://techdocs.akamai.com/mpulse/reference/queries.md) - [API summary](https://techdocs.akamai.com/mpulse/reference/api-summary.md) - [Get started](https://techdocs.akamai.com/mpulse/reference/get-started.md) - [mPulse concepts](https://techdocs.akamai.com/mpulse/reference/api-concepts.md) - [Rate limiting](https://techdocs.akamai.com/mpulse/reference/rate-limiting.md) - [Errors](https://techdocs.akamai.com/mpulse/reference/errors.md) - [400](https://techdocs.akamai.com/mpulse/reference/400.md) - [401](https://techdocs.akamai.com/mpulse/reference/401.md) - [403](https://techdocs.akamai.com/mpulse/reference/403.md) - [404](https://techdocs.akamai.com/mpulse/reference/404.md) - [429](https://techdocs.akamai.com/mpulse/reference/429.md) - [500](https://techdocs.akamai.com/mpulse/reference/500.md) - [Generate a token](https://techdocs.akamai.com/mpulse/reference/put-token.md): Authenticates and generates a token. The security token expires after five hours of inactivity. - [Delete a token](https://techdocs.akamai.com/mpulse/reference/delete-token.md): Delete a token so it can no longer be used for authentication with the API. - [List objects](https://techdocs.akamai.com/mpulse/reference/get-objects-attribute.md): Gets a list of repository objects, filtered by attributes. - [Create an object](https://techdocs.akamai.com/mpulse/reference/put-object.md): Creates an object. - [Update an object](https://techdocs.akamai.com/mpulse/reference/post-objects.md): Update a repository object. - [Get an object](https://techdocs.akamai.com/mpulse/reference/get-object.md): Gets a repository object by type and ID. - [Delete an object](https://techdocs.akamai.com/mpulse/reference/delete-objects.md): Delete a repository object. - [Clear an alert](https://techdocs.akamai.com/mpulse/reference/post-clear-alert.md): Clears a new alert from an external application. - [Trigger an alert](https://techdocs.akamai.com/mpulse/reference/post-alert-trigger.md): Triggers a new alert from an external application. - [Create an annotation](https://techdocs.akamai.com/mpulse/reference/post-annotation.md): Create a new annotation from an external application. - [List annotations](https://techdocs.akamai.com/mpulse/reference/get-annotations.md): Query for a list of annotations. - [Get an annotation](https://techdocs.akamai.com/mpulse/reference/get-annotation.md): Get an annotation by ID. - [Update an annotation](https://techdocs.akamai.com/mpulse/reference/put-annotation.md): Update an annotation by ID. - [Delete an annotation](https://techdocs.akamai.com/mpulse/reference/delete-annotation.md): Delete an annotation. - [Get timer values by A/B test](https://techdocs.akamai.com/mpulse/reference/get-ab-tests.md): Gets the Timer value by A/B Test. - [Get an application error summary](https://techdocs.akamai.com/mpulse/reference/get-app-error-summary.md): Gets App Error Messages, Codes, Sources or Types. - [Get timer values by bandwidth](https://techdocs.akamai.com/mpulse/reference/get-bandwidth.md): Gets the Timer value by Bandwidth. - [Get timer values by browser](https://techdocs.akamai.com/mpulse/reference/get-browsers.md): Gets the Timer value by Browser. - [Get a timer by minute](https://techdocs.akamai.com/mpulse/reference/get-by-minute.md): Gets the Timer value by minute. - [Get dimensions over time](https://techdocs.akamai.com/mpulse/reference/get-dimension-over-time.md): Gets the Top Dimensions over Time. - [Get dimension values](https://techdocs.akamai.com/mpulse/reference/get-dimension-values.md): Gets all Values for a dimension. - [Get timer or metric values by geography](https://techdocs.akamai.com/mpulse/reference/get-geography.md): Gets Timer or Metric values by geography. - [Get a histogram for timer](https://techdocs.akamai.com/mpulse/reference/get-histogram.md): Gets a histogram for the specified timer. - [Get metrics per page load time](https://techdocs.akamai.com/mpulse/reference/get-metric-per-page-load-time.md): Gets the Metric Count per Page Load Time. - [Get metrics by dimension](https://techdocs.akamai.com/mpulse/reference/get-metrics-by-dimension.md): Gets the values of metrics or timers by dimension. - [Get timer values by page group](https://techdocs.akamai.com/mpulse/reference/get-page-groups.md): Gets the Timer value by Page Group. - [Get sessions per page load time](https://techdocs.akamai.com/mpulse/reference/get-sessions-per-page-load-time.md): Gets the number of Sessions per Page Load Time. - [Get a timer summary](https://techdocs.akamai.com/mpulse/reference/get-summary.md): Gets the median, margin of error, count, and P95/P98 percentiles for the specified timer. - [Get timers and metrics](https://techdocs.akamai.com/mpulse/reference/get-timers-metrics.md): Gets the values for multiple timers or metrics by minute over time. You can use `metric` and `timer` parameters more than once. - [Create an mPulse domain](https://techdocs.akamai.com/mpulse/reference/put-domain.md): Create a new mPulse domain (app) with the properties specified in the payload. - [Send a beacon](https://techdocs.akamai.com/mpulse/reference/post-beacons.md): Send performance data to mPulse. To send a beacon, you need to first run the [Get a beacon configuration](ref:get-config) operation. From the response, you can use the `beacon_url` to send a beacon. See [What is in an mPulse beacon](https://techdocs.akamai.com/mpulse-boomerang/docs/whats-in-an-mpulse-beacon) for the full list of available beacon parameters. - [Get a beacon configuration](https://techdocs.akamai.com/mpulse/reference/get-config.md): You need the API Key for your mPulse app, as well as the additional required fields covered below. This operation gets the data needed in order to run the Send a Beacon operation, such as `h.key`, `h.d`, `h.t`, `h.cr` and `beacon_url`. You need to run this operation before you can send a beacon. ## Recipes - [Clear an alert](https://techdocs.akamai.com/mpulse/recipes/clear-an-alert.md) - [Create an annotation](https://techdocs.akamai.com/mpulse/recipes/create-an-annotation.md) - [Create an object](https://techdocs.akamai.com/mpulse/recipes/create-an-object.md) - [Delete an annotation](https://techdocs.akamai.com/mpulse/recipes/delete-an-annotation.md) - [Delete an object](https://techdocs.akamai.com/mpulse/recipes/delete-an-object.md) - [Generate a token](https://techdocs.akamai.com/mpulse/recipes/generate-a-token.md) - [Get a beacon configuration](https://techdocs.akamai.com/mpulse/recipes/get-a-beacon-configuration.md) - [Get a histogram for timer](https://techdocs.akamai.com/mpulse/recipes/get-a-histogram-for-timer.md) - [Get a timer by minute](https://techdocs.akamai.com/mpulse/recipes/get-a-timer-by-minute.md) - [Get a timer summary](https://techdocs.akamai.com/mpulse/recipes/get-a-timer-summary.md) - [Get an annotation](https://techdocs.akamai.com/mpulse/recipes/get-an-annotation.md) - [Get an application error summary](https://techdocs.akamai.com/mpulse/recipes/get-an-application-error-summary.md) - [Get an object](https://techdocs.akamai.com/mpulse/recipes/get-an-object.md) - [Get dimension values](https://techdocs.akamai.com/mpulse/recipes/get-dimension-values.md) - [Get dimensions over time](https://techdocs.akamai.com/mpulse/recipes/get-dimensions-over-time.md) - [Get metrics by dimension](https://techdocs.akamai.com/mpulse/recipes/get-metrics-by-dimension.md) - [Get metrics per page load time](https://techdocs.akamai.com/mpulse/recipes/get-metrics-per-page-load-time.md) - [Get session per page load time](https://techdocs.akamai.com/mpulse/recipes/get-session-per-page-load-time.md) - [Get timer or metric values by geography](https://techdocs.akamai.com/mpulse/recipes/get-timer-or-metric-values-by-geography.md) - [Get timer values by A/B test](https://techdocs.akamai.com/mpulse/recipes/get-timer-values-by-ab-test.md) - [Get timer values by bandwidth](https://techdocs.akamai.com/mpulse/recipes/get-timer-values-by-bandwidth.md) - [Get timer values by browser](https://techdocs.akamai.com/mpulse/recipes/get-timer-values-by-browser.md) - [Get timer values by page group](https://techdocs.akamai.com/mpulse/recipes/get-timer-values-by-page-group.md) - [Get timers and metrics](https://techdocs.akamai.com/mpulse/recipes/get-timers-and-metrics.md) - [List annotations](https://techdocs.akamai.com/mpulse/recipes/list-annotations.md) - [List objects](https://techdocs.akamai.com/mpulse/recipes/list-objects.md) - [Send a beacon](https://techdocs.akamai.com/mpulse/recipes/send-a-beacon.md) - [Trigger an alert](https://techdocs.akamai.com/mpulse/recipes/trigger-an-alert.md) - [Update an annotation](https://techdocs.akamai.com/mpulse/recipes/update-an-annotation.md) - [Update an object](https://techdocs.akamai.com/mpulse/recipes/update-an-object.md) ## Changelog - [August 25, 2025 – Alerts in the New UI](https://techdocs.akamai.com/mpulse/changelog/august-25-2025-alerts-in-the-new-ui.md) - [Mar 10, 2025 – TrafficPeak integration support (Limited Availability)](https://techdocs.akamai.com/mpulse/changelog/mar-10-2025-trafficpeak-integration-support-limited-availability.md) - [Mar 6, 2025 – Private dashboard sharing update](https://techdocs.akamai.com/mpulse/changelog/mar-6-2025-private-dashboard-sharing-update.md) - [Feb 6, 2025 — Bug fix](https://techdocs.akamai.com/mpulse/changelog/feb-6-2025-bug-fix.md) - [Dec 13, 2024 — Frustration Index and Public Dashboard Sharing](https://techdocs.akamai.com/mpulse/changelog/dec-13-2024-frustration-index-and-public-dashboard-sharing.md) # mPulse Boomerang Documentation > Akamai's mPulse Boomerang is a JavaScript library for real user monitoring (commonly called RUM). Boomerang measures the performance characteristics of real-world page loads and interactions. ## Guides - [Welcome to mPulse Boomerang](https://techdocs.akamai.com/mpulse-boomerang/docs/welcome-to-mpulse-boomerang.md) - [Supported features](https://techdocs.akamai.com/mpulse-boomerang/docs/supported-features.md) - [Errors](https://techdocs.akamai.com/mpulse-boomerang/docs/errors.md) - [Implementation](https://techdocs.akamai.com/mpulse-boomerang/docs/implementation.md) - [Single page apps](https://techdocs.akamai.com/mpulse-boomerang/docs/single-page-apps.md) - [Third party analytics (big beacon)](https://techdocs.akamai.com/mpulse-boomerang/docs/third-party-analytics-big-beacon.md) - [Early beacon](https://techdocs.akamai.com/mpulse-boomerang/docs/early-beacon.md) - [Cookies](https://techdocs.akamai.com/mpulse-boomerang/docs/cookies.md) - [Local storage](https://techdocs.akamai.com/mpulse-boomerang/docs/local-storage.md) - [Boomerang flavors](https://techdocs.akamai.com/mpulse-boomerang/docs/boomerang-flavors.md) - [Managing the ResourceTiming buffer](https://techdocs.akamai.com/mpulse-boomerang/docs/managing-the-resourcetiming-buffer.md) - [Content Security Policy (CSP)](https://techdocs.akamai.com/mpulse-boomerang/docs/content-security-policy-csp.md) - [mPulse and Boomerang blocked as tracker](https://techdocs.akamai.com/mpulse-boomerang/docs/mpulse-and-boomerang-blocked-as-tracker.md) - [The Boomerang Akamai plugin](https://techdocs.akamai.com/mpulse-boomerang/docs/the-boomerang-akamai-plugin.md) - [Support for user agent reduction and client hints](https://techdocs.akamai.com/mpulse-boomerang/docs/support-for-user-agent-reduction-and-client-hits.md) - [Browser developer tools](https://techdocs.akamai.com/mpulse-boomerang/docs/browser-developer-tools.md) - [Running Boomerang in a development environment](https://techdocs.akamai.com/mpulse-boomerang/docs/running-boomerang-in-a-development-environment.md) - [Problems](https://techdocs.akamai.com/mpulse-boomerang/docs/problems.md) - [What is in an mPulse beacon](https://techdocs.akamai.com/mpulse-boomerang/docs/whats-in-an-mpulse-beacon.md) - [How mPulse XHR and SPA monitoring works](https://techdocs.akamai.com/mpulse-boomerang/docs/how-mpulse-xhr-and-spa-monitoring-works.md) - [Send custom data with mPulse](https://techdocs.akamai.com/mpulse-boomerang/docs/send-custom-data-with-mpulse.md) ## API Reference - [mPulse Boomerang API](https://techdocs.akamai.com/mpulse-boomerang/reference/welcome.md) ## Changelog - [Nov 22, 2024 — Boomerang 1.815 Limited Availability Release](https://techdocs.akamai.com/mpulse-boomerang/changelog/nov-22-2024-boomerang-1815-limited-availability-release.md) - [Mar 25, 2024 — Boomerang 1.803 Limited Availability Release](https://techdocs.akamai.com/mpulse-boomerang/changelog/mar-25-2024-new-features-and-bug-fixes.md) - [Oct 23, 2023 — New features and bug fixes](https://techdocs.akamai.com/mpulse-boomerang/changelog/oct-23-2023-new-features-and-bug-fixes.md) - [Jul 17, 2023 — Breaking changes, features, bug fixes](https://techdocs.akamai.com/mpulse-boomerang/changelog/jul-17-2023-features-bug-fixes.md) - [Oct 10, 2022 — New features and bug fixes](https://techdocs.akamai.com/mpulse-boomerang/changelog/sep-9-2022-new-features-and-bug-fixes.md) # MSL5 Powered by Harmonic Documentation > Documentation for MSL5 Powered by Harmonic ## Guides - [Media Services Live 5 overview](https://techdocs.akamai.com/msl5-harmonic/docs/welcome-to-msl5.md) - [MSL4 to MSL5: Key Benefits and Rationale](https://techdocs.akamai.com/msl5-harmonic/docs/msl4-to-msl5-key-benefits-and-rationale.md) - [Migration guide](https://techdocs.akamai.com/msl5-harmonic/docs/migration-guide.md) - [MSL5 Migration Guide - Final Phase ](https://techdocs.akamai.com/msl5-harmonic/docs/msl5-migration-guide-final-phase.md) - [MSL5 Migration Guide - Event purge and unlimited archive](https://techdocs.akamai.com/msl5-harmonic/docs/msl5-migration-guide-event-purge-and-unlimited-archive.md) - [Access MSL5](https://techdocs.akamai.com/msl5-harmonic/docs/access-msl5.md) - [Landing page](https://techdocs.akamai.com/msl5-harmonic/docs/landing-page.md) - [Terraform support for MSL5 ](https://techdocs.akamai.com/msl5-harmonic/docs/terraform-support-for-msl5.md) - [Create an MSL5 stream](https://techdocs.akamai.com/msl5-harmonic/docs/create-msl5-stream.md) - [Clip an event](https://techdocs.akamai.com/msl5-harmonic/docs/clip-an-event.md) - [Export clipped events to a storage connection ](https://techdocs.akamai.com/msl5-harmonic/docs/export-clipped-events-to-a-storage-connection.md) - [Add log export to S3 object storage](https://techdocs.akamai.com/msl5-harmonic/docs/add-log-export-to-s3-object-storage.md) - [Use the Instant TV and Live2VOD features](https://techdocs.akamai.com/msl5-harmonic/docs/use-the-instant-tv-and-live2vod-features.md) - [Integration with Adaptive Media Delivery using Instant TV and Live2VOD features](https://techdocs.akamai.com/msl5-harmonic/docs/integration-with-akamai-amd.md) - [Set up the MSL5 origin](https://techdocs.akamai.com/msl5-harmonic/docs/set-up-the-msl5-origin.md) - [Get your Stream ID](https://techdocs.akamai.com/msl5-harmonic/docs/get-your-stream-id.md) - [Configure an Origin for the Stream](https://techdocs.akamai.com/msl5-harmonic/docs/configure-an-origin-for-your-stream.md) - [Configure G2O Authentication in Akamai AMD](https://techdocs.akamai.com/msl5-harmonic/docs/configure-g2o-authentication-in-akamai-amd.md) - [Go Live in AMD with MSL5 origin](https://techdocs.akamai.com/msl5-harmonic/docs/go-live-in-amd-with-msl5-origin.md) - [Configure AMD property for redundant MSL5 origins](https://techdocs.akamai.com/msl5-harmonic/docs/configure-amd-property-for-redundant-msl5-origins.md) - [Generate publish and playback URLs](https://techdocs.akamai.com/msl5-harmonic/docs/generate-publish-and-playback-urls.md) - [HLS](https://techdocs.akamai.com/msl5-harmonic/docs/hls.md) - [DASH](https://techdocs.akamai.com/msl5-harmonic/docs/dash.md) - [CMAF](https://techdocs.akamai.com/msl5-harmonic/docs/cmaf.md) - [Edit and delete streams](https://techdocs.akamai.com/msl5-harmonic/docs/edit-and-delete-streams.md) - [Update username and password](https://techdocs.akamai.com/msl5-harmonic/docs/update-username-and-password.md) - [Delete a credential](https://techdocs.akamai.com/msl5-harmonic/docs/delete-a-credential.md) - [Export storage](https://techdocs.akamai.com/msl5-harmonic/docs/export-storage.md) - [Create a storage connection for exports ](https://techdocs.akamai.com/msl5-harmonic/docs/create-a-storage-connection-for-exports.md) - [Access Management](https://techdocs.akamai.com/msl5-harmonic/docs/access-management.md) - [API Token](https://techdocs.akamai.com/msl5-harmonic/docs/api-token.md) - [Start an emergency token rotation](https://techdocs.akamai.com/msl5-harmonic/docs/start-an-emergency-token-rotation.md) - [CP Tag](https://techdocs.akamai.com/msl5-harmonic/docs/cp-tag.md) - [Group](https://techdocs.akamai.com/msl5-harmonic/docs/group.md) - [Documentation](https://techdocs.akamai.com/msl5-harmonic/docs/documentation.md) - [Alerts](https://techdocs.akamai.com/msl5-harmonic/docs/alerts.md) - [Audit logs](https://techdocs.akamai.com/msl5-harmonic/docs/audit-log.md) - [Metrics](https://techdocs.akamai.com/msl5-harmonic/docs/metrics.md) - [Usage reports](https://techdocs.akamai.com/msl5-harmonic/docs/usage-reports.md) - [Ingest specifications](https://techdocs.akamai.com/msl5-harmonic/docs/ingest-specifications.md) - [Stream creation quota](https://techdocs.akamai.com/msl5-harmonic/docs/stream-creation-quota.md) - [MSL5 origin application specifications](https://techdocs.akamai.com/msl5-harmonic/docs/msl5-origin-application-specifications.md) - [Media file formats](https://techdocs.akamai.com/msl5-harmonic/docs/supported-media-file-formats.md) - [Geographical locations supported by MSL5](https://techdocs.akamai.com/msl5-harmonic/docs/geographical-locations-supported-by-msl5.md) - [Archive options](https://techdocs.akamai.com/msl5-harmonic/docs/archive-options.md) - [MSL5 Origin Low-Latency HLS ingest requirements](https://techdocs.akamai.com/msl5-harmonic/docs/msl5-origin-low-latency-hls-ingest-requirements.md) ## API Reference - [MSL5 API](https://techdocs.akamai.com/msl5-harmonic/reference/api.md) - [API summary](https://techdocs.akamai.com/msl5-harmonic/reference/api-summary.md) - [Get started with MSL5 API](https://techdocs.akamai.com/msl5-harmonic/reference/get-started.md) - [API concepts](https://techdocs.akamai.com/msl5-harmonic/reference/api-concepts.md) - [API workflow](https://techdocs.akamai.com/msl5-harmonic/reference/api-workflow.md) - [Content Purge API workflow](https://techdocs.akamai.com/msl5-harmonic/reference/content-purge-api-workflow.md) - [API performance](https://techdocs.akamai.com/msl5-harmonic/reference/api-performance.md) - [Errors](https://techdocs.akamai.com/msl5-harmonic/reference/errors.md) - [HTTP status codes](https://techdocs.akamai.com/msl5-harmonic/reference/http-status-codes.md) - [200](https://techdocs.akamai.com/msl5-harmonic/reference/204-copy.md): Operation was successful - [201](https://techdocs.akamai.com/msl5-harmonic/reference/201.md): Resource created - [202](https://techdocs.akamai.com/msl5-harmonic/reference/202.md): The resource was successfully accepted - [204](https://techdocs.akamai.com/msl5-harmonic/reference/204.md): Successful deletion - [400](https://techdocs.akamai.com/msl5-harmonic/reference/400.md): Bad Request - [401](https://techdocs.akamai.com/msl5-harmonic/reference/401.md): Unauthorized request - [403](https://techdocs.akamai.com/msl5-harmonic/reference/403.md): Access is forbidden - [404](https://techdocs.akamai.com/msl5-harmonic/reference/404.md): Resource not found - [409](https://techdocs.akamai.com/msl5-harmonic/reference/409.md): There is a conflict in the resource (for instance in an attempt to delete an entity that is still active). - [412](https://techdocs.akamai.com/msl5-harmonic/reference/412.md): Precondition failed. - [500](https://techdocs.akamai.com/msl5-harmonic/reference/500.md): Internal server error. - [List alert configurations](https://techdocs.akamai.com/msl5-harmonic/reference/get-v1-alert-configurations.md): List alert configurations. - [Get alert configuration by ID](https://techdocs.akamai.com/msl5-harmonic/reference/get-v1-alert-configuration-id.md): Get a specific alert configuration by ID. - [Update alert configuration](https://techdocs.akamai.com/msl5-harmonic/reference/put-v1-alert-configuration-id.md): Update an existing alert configuration. **Immutable fields** — the following fields cannot be changed after creation. If the request body contains a different value, the API returns 400: - `alert_type_id` **Editable fields** — all other fields can be updated, including `name`. If the new name conflicts with an existing alert owned by the same user, the API returns 409. For Phase 2 (dynamic/non-preset) alert types, changes are synced to SignOz before the database is updated. If SignOz rejects the change, the database remains untouched. - [Delete alert configuration](https://techdocs.akamai.com/msl5-harmonic/reference/delete-v1-alert-configuration-id.md): Delete an alert configuration. - [Create alert configuration](https://techdocs.akamai.com/msl5-harmonic/reference/post-v1-alert-configuration.md): Create a new alert configuration. - [Subscribe to alert configuration](https://techdocs.akamai.com/msl5-harmonic/reference/post-v1-alert-configuration-id-subscribe.md): Subscribe to an alert configuration. Start receiving the alert email notification. - [Unsubscribe from alert configuration](https://techdocs.akamai.com/msl5-harmonic/reference/post-v1-alert-configuration-id-unsubscribe.md): Unsubscribe from an alert configuration. Stop receiving the alert email notification. - [Activate alert configuration](https://techdocs.akamai.com/msl5-harmonic/reference/post-v1-alert-configuration-id-activate.md): Activate an alert configuration. Start sending the alert notification email. - [Deactivate alert configuration](https://techdocs.akamai.com/msl5-harmonic/reference/post-v1-alert-configuration-id-deactivate.md): Deactivate an alert configuration. Stop sending the alert notification email. - [List triggered alerts](https://techdocs.akamai.com/msl5-harmonic/reference/get-v1-alert-triggers.md): List alert given alert configuration_id (optional), start_time (optional), end_time (optional), status (optional). - [List alert types](https://techdocs.akamai.com/msl5-harmonic/reference/get-v1-alert-types.md): List alert types. - [Get alert type by ID](https://techdocs.akamai.com/msl5-harmonic/reference/get-v1-alert-type-id.md): Get specific alert type by ID. - [Retrieve usage data](https://techdocs.akamai.com/msl5-harmonic/reference/get-v1-usage-startdate-startdate-enddate-enddate.md): Retrieve usage data for specified date range and filters. Returns ingest, storage, and processing metrics aggregated by date, contract, and CP tag. - [List CP Tags](https://techdocs.akamai.com/msl5-harmonic/reference/list_cptags.md): Lists all accessible CP Tags. - [Create CP Tag](https://techdocs.akamai.com/msl5-harmonic/reference/create_cptag.md): Creates a new CP Tag. - [Create origin server](https://techdocs.akamai.com/msl5-harmonic/reference/create_origin.md): Creates a new origin server. Hostname must be unique and zones must be different. Any optional field that is omitted will use its default value as documented on each field. - [List origins](https://techdocs.akamai.com/msl5-harmonic/reference/list_origins.md): Lists all accessible origin servers. Admins see all origins in the system. - [Get origin details](https://techdocs.akamai.com/msl5-harmonic/reference/get_origin.md): Retrieves origin server configuration and status. - [Delete origin](https://techdocs.akamai.com/msl5-harmonic/reference/delete_origin.md): Permanently removes an origin server. Fails if origin has active streams. - [Update origins](https://techdocs.akamai.com/msl5-harmonic/reference/put_origins.md): Update an existing origin's configuration. - [List publishing locations](https://techdocs.akamai.com/msl5-harmonic/reference/list_publishing_locations.md): List all accessible publishing locations. - [List S3 storage connections](https://techdocs.akamai.com/msl5-harmonic/reference/list_s3_storage_connections.md): Lists S3 storage connections for the authenticated account. - [Create S3 storage connection](https://techdocs.akamai.com/msl5-harmonic/reference/create_s3_storage_connection.md): Creates a new S3-compatible storage connection with inline connectivity validation. - [Get S3 storage connection](https://techdocs.akamai.com/msl5-harmonic/reference/get_s3_storage_connection.md): Retrieves an S3 storage connection by ID. - [Update S3 storage connection](https://techdocs.akamai.com/msl5-harmonic/reference/update_s3_storage_connection.md): Updates an S3 storage connection with inline connectivity re-validation. - [Delete S3 storage connection](https://techdocs.akamai.com/msl5-harmonic/reference/delete_s3_storage_connection.md): Soft-deletes an S3 storage connection. - [Create stream](https://techdocs.akamai.com/msl5-harmonic/reference/create_stream.md): Create a new stream with the specified configuration. Any optional field that is omitted will use its default value as documented on each field. - [List streams](https://techdocs.akamai.com/msl5-harmonic/reference/list_streams.md): List all accessible streams. - [Get stream details](https://techdocs.akamai.com/msl5-harmonic/reference/get_stream.md): Get detailed information about a specific stream, including origin hostname details for both primary and backup locations. - [Import a v4 stream](https://techdocs.akamai.com/msl5-harmonic/reference/import_stream.md): Imports an existing stream configuration from v4 format. - [Update stream](https://techdocs.akamai.com/msl5-harmonic/reference/update_stream.md): Update an existing stream's configuration. This is a full update; omitted optional fields will be reset to their default values, not preserved. See each field description for details. - [Delete stream](https://techdocs.akamai.com/msl5-harmonic/reference/delete_stream.md): Delete a stream and its associated resources. - [Create event](https://techdocs.akamai.com/msl5-harmonic/reference/create_event.md): Create a new event. Async-created events include `clipping` in responses; sync-created events omit it. - [List events](https://techdocs.akamai.com/msl5-harmonic/reference/list_events.md): List all events for a stream. - [Get event details](https://techdocs.akamai.com/msl5-harmonic/reference/get_event.md): Get detailed information about an event. - [Delete event](https://techdocs.akamai.com/msl5-harmonic/reference/delete_event.md): Delete an event. - [Delete event retention buffer](https://techdocs.akamai.com/msl5-harmonic/reference/delete_event_retention_buffer.md): Delete an event's retention buffer. This will mark recorded content as unavailable within a given time range - [List event's deleted retention buffer](https://techdocs.akamai.com/msl5-harmonic/reference/list_event_deleted_retention_buffer.md): Lists all time ranges of segments marked as unavailable for the specified event. - [List event exports](https://techdocs.akamai.com/msl5-harmonic/reference/list_event_exports.md): List all export tasks for an event. - [Create event export](https://techdocs.akamai.com/msl5-harmonic/reference/create_event_export.md): Create a new event export task to export an event to S3 storage. - [Get event export](https://techdocs.akamai.com/msl5-harmonic/reference/get_event_export.md): Get details of a specific export task. - [Cancel event export](https://techdocs.akamai.com/msl5-harmonic/reference/cancel_event_export.md): Cancel a queued or running export task. - [Create ingest credential](https://techdocs.akamai.com/msl5-harmonic/reference/create_ingest_credential.md): Create new ingest credentials. - [List ingest credentials](https://techdocs.akamai.com/msl5-harmonic/reference/list_ingest_credentials.md): List all ingest credentials for a stream. - [Update ingest credential](https://techdocs.akamai.com/msl5-harmonic/reference/update_ingest_credential.md): Update ingest credential metadata. - [Delete ingest credential](https://techdocs.akamai.com/msl5-harmonic/reference/delete_ingest_credential.md): Remove ingest credentials. - [List log destinations](https://techdocs.akamai.com/msl5-harmonic/reference/list_log_destinations.md): List all log destinations for a stream. - [Create log destination](https://techdocs.akamai.com/msl5-harmonic/reference/create_log_destination.md): Create a new log destination for a stream. - [Get log destination details](https://techdocs.akamai.com/msl5-harmonic/reference/get_log_destination.md): Get detailed information about a log destination. - [Update log destination](https://techdocs.akamai.com/msl5-harmonic/reference/update_log_destination.md): Update an existing log destination. - [Delete log destination](https://techdocs.akamai.com/msl5-harmonic/reference/delete_log_destination.md): Delete a log destination. - [Activate log destination](https://techdocs.akamai.com/msl5-harmonic/reference/activate_log_destination.md): Activate a log destination to start exporting logs. - [Deactivate log destination](https://techdocs.akamai.com/msl5-harmonic/reference/deactivate_log_destination.md): Deactivate a log destination to stop exporting logs. ## Changelog - [Jun 29, 2026 — Archive Export UI issue resolved](https://techdocs.akamai.com/msl5-harmonic/changelog/jun-29-2026-archive-export-issue-resolved.md) - [Jun 23, 2026 — MSL5 Production Release](https://techdocs.akamai.com/msl5-harmonic/changelog/jun-23-2026-msl5-production-release.md) - [Apr 28, 2026 — MSL5 Production Release](https://techdocs.akamai.com/msl5-harmonic/changelog/apr-28-2026-msl5-production-release.md) - [Jan 29, 2026 — MSL5 Origin system stability update](https://techdocs.akamai.com/msl5-harmonic/changelog/jan-29-2026-msl5-origin-system-stability-update.md) - [Jan 27, 2026 — MSL5 Production Release](https://techdocs.akamai.com/msl5-harmonic/changelog/jan-27-2026-msl5-production-release.md) # Mutual TLS Edge Truststore (Limited Availability) Documentation > Mutual TLS Edge Truststore is a self-service application that supports the creation, management, and activation of certificate authority certificate sets (CA sets) needed to establish mutual authentication (mTLS) sessions between the client and the Akamai edge. ## Guides - [Welcome to Mutual TLS Edge Truststore (Limited Availability)](https://techdocs.akamai.com/mtls-edge-truststore/docs/welcome.md) - [Key concepts and terms](https://techdocs.akamai.com/mtls-edge-truststore/docs/key-concepts-terms.md) - [Certificate expiration notification](https://techdocs.akamai.com/mtls-edge-truststore/docs/certificate-expiration-notification.md) - [Create CA set workflow overview](https://techdocs.akamai.com/mtls-edge-truststore/docs/ca-set-workflow.md) - [Protect connections with mTLS](https://techdocs.akamai.com/mtls-edge-truststore/docs/protect-connections-with-mtls.md) - [Manage a CA set](https://techdocs.akamai.com/mtls-edge-truststore/docs/manage-ca-sets.md) - [Best practices](https://techdocs.akamai.com/mtls-edge-truststore/docs/best-practices.md) - [Manage certificates in a set](https://techdocs.akamai.com/mtls-edge-truststore/docs/manage-cert-set.md) ## API Reference - [mTLS Edge Truststore API v2](https://techdocs.akamai.com/mtls-edge-truststore/reference/api.md) - [API summary](https://techdocs.akamai.com/mtls-edge-truststore/reference/api-summary.md) - [Get started](https://techdocs.akamai.com/mtls-edge-truststore/reference/api-get-started.md) - [API concepts](https://techdocs.akamai.com/mtls-edge-truststore/reference/api-concepts.md) - [Rate and resource limiting](https://techdocs.akamai.com/mtls-edge-truststore/reference/rate-resource-limit.md) - [API Hypermedia](https://techdocs.akamai.com/mtls-edge-truststore/reference/api-hypermedia.md) - [Object versioning](https://techdocs.akamai.com/mtls-edge-truststore/reference/object-versioning.md) - [Enumeration values](https://techdocs.akamai.com/mtls-edge-truststore/reference/enumeration-values.md) - [API workflow](https://techdocs.akamai.com/mtls-edge-truststore/reference/api-workflow.md) - [Errors](https://techdocs.akamai.com/mtls-edge-truststore/reference/errors.md) - [400](https://techdocs.akamai.com/mtls-edge-truststore/reference/400.md) - [401](https://techdocs.akamai.com/mtls-edge-truststore/reference/401.md) - [403](https://techdocs.akamai.com/mtls-edge-truststore/reference/403.md) - [404](https://techdocs.akamai.com/mtls-edge-truststore/reference/404.md) - [405](https://techdocs.akamai.com/mtls-edge-truststore/reference/405.md) - [406](https://techdocs.akamai.com/mtls-edge-truststore/reference/406.md) - [409](https://techdocs.akamai.com/mtls-edge-truststore/reference/409.md) - [415](https://techdocs.akamai.com/mtls-edge-truststore/reference/415.md) - [422](https://techdocs.akamai.com/mtls-edge-truststore/reference/422.md) - [429](https://techdocs.akamai.com/mtls-edge-truststore/reference/429.md) - [500](https://techdocs.akamai.com/mtls-edge-truststore/reference/500.md) - [503](https://techdocs.akamai.com/mtls-edge-truststore/reference/503.md) - [Create a CA set](https://techdocs.akamai.com/mtls-edge-truststore/reference/post-ca-set.md): Create a CA set with the provided name. - [List CA sets](https://techdocs.akamai.com/mtls-edge-truststore/reference/get-ca-sets.md): List CA sets created under the account. - [Get a CA set](https://techdocs.akamai.com/mtls-edge-truststore/reference/get-ca-set.md): Get details of a CA set. - [Delete a CA set](https://techdocs.akamai.com/mtls-edge-truststore/reference/delete-ca-set.md): Delete the CA set for given `caSetId`. - [List CA set activations](https://techdocs.akamai.com/mtls-edge-truststore/reference/get-deployment-request-for-ca-set.md): List all activation and deactivation requests for the CA set. - [List CA set activities](https://techdocs.akamai.com/mtls-edge-truststore/reference/get-ca-set-activities.md): List activities on the CA set, sorted reverse chronologically with recent activities first. Apply `start` and `end` parameters to specify a time range. Specify only `start` or `end` to include all activities after or before a given time. - [Get CA set associations](https://techdocs.akamai.com/mtls-edge-truststore/reference/get-ca-set-associations.md): Get a CA set Associations. - [Clone a CA set](https://techdocs.akamai.com/mtls-edge-truststore/reference/post-clone-ca-set.md): Clones a CA set. If you provide the optional cloneFromVersion parameter, the clone is created from that version; otherwise, it uses the latest version. The cloned set may include expired certificates from the source version. - [Get CA set delete status](https://techdocs.akamai.com/mtls-edge-truststore/reference/get-deletion-request-for-ca-set.md): Retrieves the status of a CA set deletion request, including its progress, overall status, and any network-specific failures. - [Create a version](https://techdocs.akamai.com/mtls-edge-truststore/reference/post-ca-set-version.md): Create a new CA set version in the CA set specified by `caSetId`. When creating a new version, the API compares the certificates and SHA-1 provided in the request with the existing versions in the CA set. If another version exists with fingerprints for the same certificates, a 422 response provides a link to the version. If the `allowInsecureSha1` option differs between the versions with the same certificates, they're still considered the same CA set version. This prevents creating duplicate CA set versions. - [List versions](https://techdocs.akamai.com/mtls-edge-truststore/reference/get-ca-set-versions.md): Versions of the CA set specified by `caSetId`. - [Get a version](https://techdocs.akamai.com/mtls-edge-truststore/reference/get-ca-set-version.md): Get the CA set version details. - [Update a version](https://techdocs.akamai.com/mtls-edge-truststore/reference/put-ca-set-version.md): Update all the certificates for the version, or the `allowInsecureSha1` that controls what type of certificates to allow. - [Activate a version](https://techdocs.akamai.com/mtls-edge-truststore/reference/post-activate-ca-set-version.md): Activate the certificates for the version on the specified network. - [Get version activations](https://techdocs.akamai.com/mtls-edge-truststore/reference/get-version-deployment-request-details.md): Get details of an activation or deactivation request by set ID and version number. - [Get an activation](https://techdocs.akamai.com/mtls-edge-truststore/reference/get-deployment-request-details.md): Get details of an activation or deactivation request specified by `activationId`. - [List certificates](https://techdocs.akamai.com/mtls-edge-truststore/reference/get-ca-set-version-certificates.md): List certificates for the specified version. - [Clone a version](https://techdocs.akamai.com/mtls-edge-truststore/reference/post-clone-ca-set-version.md): Clone a version of the CA set from the CA set specified by `version`. Note that the clone may reflect expired certificates from the original. - [Deactivate a version](https://techdocs.akamai.com/mtls-edge-truststore/reference/post-deactivate-ca-set-version.md): Deactivate the certificates for the version on the specified network. - [Delete a version](https://techdocs.akamai.com/mtls-edge-truststore/reference/delete-ca-set-version.md): Marks the CA set version (`versionNumber`) in a specified CA set (`caSetId`) for future deletion without removing it from the system. When you [Create a version](ref:post-ca-set-version), the new CA set version takes the subsequent `versionNumber` irregardless of earlier versions scheduled for deletion. - [Validate certificates](https://techdocs.akamai.com/mtls-edge-truststore/reference/post-validate-certificates.md): Validates a list of certificates passed in PEM format and returns validation results for each certificate. The operation fails if any certificate is invalid. ## Changelog - [Mar 16, 2026 - Mutual TLS Edge Truststore access expanded to all accounts in Akamai Control Center](https://techdocs.akamai.com/mtls-edge-truststore/changelog/mar-16-2026-mutual-tls-edge-truststore-access-expanded-to-all-accounts.md) - [Sept 29, 2025 — Mutual TLS Edge Truststore V2 APIs](https://techdocs.akamai.com/mtls-edge-truststore/changelog/sept-29-2025-mtls-edge-truststore-v2-apis.md) - [Jun 13, 2024 — Mutual TLS Edge Truststore update](https://techdocs.akamai.com/mtls-edge-truststore/changelog/jun-13-2024-mutual-tls-edge-truststore-update.md) - [May 16, 2024 — Mutual TLS Edge Truststore update](https://techdocs.akamai.com/mtls-edge-truststore/changelog/may-16-2024.md) - [Oct 25, 2023 — Mutual TLS Edge Truststore: Customer Migration](https://techdocs.akamai.com/mtls-edge-truststore/changelog/oct-25-2023-mtls-edge-truststore-customer-migration.md) # Mutual TLS Origin Keystore Documentation > Use Mutual TLS Origin Keystore to manage client certificates for mTLS authentication between the Akamai edge server and the origin. ## Guides - [Welcome to Mutual TLS Origin Keystore](https://techdocs.akamai.com/mtls-origin-keystore/docs/welcome.md) - [Key concepts and terms](https://techdocs.akamai.com/mtls-origin-keystore/docs/key-concepts-and-terms.md) - [Best practices](https://techdocs.akamai.com/mtls-origin-keystore/docs/best-practices.md) - [Create a client certificate](https://techdocs.akamai.com/mtls-origin-keystore/docs/create-a-client-certificate.md) - [Client certificates](https://techdocs.akamai.com/mtls-origin-keystore/docs/manage-client-certificates.md): This section describes the actions used to manage your client certificates. - [Account CA certificates](https://techdocs.akamai.com/mtls-origin-keystore/docs/acct-ca-certs.md) ## API Reference - [Mutual TLS Origin Keystore API](https://techdocs.akamai.com/mtls-origin-keystore/reference/api.md) - [API summary](https://techdocs.akamai.com/mtls-origin-keystore/reference/api-summary.md) - [Get started](https://techdocs.akamai.com/mtls-origin-keystore/reference/get-started.md) - [API concepts](https://techdocs.akamai.com/mtls-origin-keystore/reference/api-concepts.md) - [Rate limiting](https://techdocs.akamai.com/mtls-origin-keystore/reference/rate-resource-limit.md) - [API workflow](https://techdocs.akamai.com/mtls-origin-keystore/reference/api-workflow.md) - [Errors](https://techdocs.akamai.com/mtls-origin-keystore/reference/errors.md) - [400](https://techdocs.akamai.com/mtls-origin-keystore/reference/400.md) - [401](https://techdocs.akamai.com/mtls-origin-keystore/reference/401.md) - [403](https://techdocs.akamai.com/mtls-origin-keystore/reference/403.md) - [404](https://techdocs.akamai.com/mtls-origin-keystore/reference/404.md) - [405](https://techdocs.akamai.com/mtls-origin-keystore/reference/405.md): Method Not Allowed - [409](https://techdocs.akamai.com/mtls-origin-keystore/reference/409.md): Conflict - [415](https://techdocs.akamai.com/mtls-origin-keystore/reference/415.md): Unsupported Media Type - [429](https://techdocs.akamai.com/mtls-origin-keystore/reference/429.md) - [500](https://techdocs.akamai.com/mtls-origin-keystore/reference/500.md) - [List account CA certificates](https://techdocs.akamai.com/mtls-origin-keystore/reference/get-ca-certs.md): List CA certificates under the account. - [Rotate a client certificate](https://techdocs.akamai.com/mtls-origin-keystore/reference/post-client-cert-version.md): Create a new version in the client certificate specified by `certificateId`. - [List client certificate versions](https://techdocs.akamai.com/mtls-origin-keystore/reference/get-client-cert-versions.md): Versions of the client certificate specified by `certificateId`. - [Delete a client certificate version](https://techdocs.akamai.com/mtls-origin-keystore/reference/delete-client-certificate.md): Delete a client certificate version with the provided `certificateId` and `version`. [Learn more](doc:manage-client-certificates#delete-a-client-certificate-version). - [Upload a signed client certificate](https://techdocs.akamai.com/mtls-origin-keystore/reference/post-cert-block.md): Upload a signed `THIRD_PARTY` client certificate with the `AWAITING_SIGNED_CERTIFICATE` status. [Learn more](https://techdocs.akamai.com/mtls-origin-keystore/docs/upload-cert). - [Create a client certificate](https://techdocs.akamai.com/mtls-origin-keystore/reference/post-client-cert.md): Create a client certificate with the provided name. - [List client certificates under the account](https://techdocs.akamai.com/mtls-origin-keystore/reference/get-client-certs.md): List client certificates under the account. - [Get a client certificate](https://techdocs.akamai.com/mtls-origin-keystore/reference/get-client-cert.md): Get details of a client certificate. - [Patch a client certificate](https://techdocs.akamai.com/mtls-origin-keystore/reference/patch-client-cert.md): Update the client certificate's name or notification emails. ## Changelog - [Aug 6, 2025 — Mutual TLS Origin Keystore GA](https://techdocs.akamai.com/mtls-origin-keystore/changelog/aug-6-2025-mutual-tls-origin-keystore-ga.md) - [Aug 30, 2024 — New Mutual TLS Origin Keystore](https://techdocs.akamai.com/mtls-origin-keystore/changelog/aug-26-2024-new-mutual-origin-keystore.md) # NetStorage Documentation > NetStorage is a holistic solution for maintaining large collections of on-demand digital content-including electronic images, streaming media files, software, documents, and other digital objects-while also offering performance compatible with today’s online delivery needs and customers’ expectations of instant access. ## Guides - [Welcome to NetStorage](https://techdocs.akamai.com/netstorage/docs/welcome-to-netstorage.md) - [NetStorage file structure](https://techdocs.akamai.com/netstorage/docs/netstorage-file-structure.md) - [Key concepts and terms](https://techdocs.akamai.com/netstorage/docs/key-concepts-and-terms.md) - [Create a technical contact](https://techdocs.akamai.com/netstorage/docs/create-a-netstorage-technical-contact.md) - [Access NetStorage in Control Center](https://techdocs.akamai.com/netstorage/docs/access-netstorage-in-control-center.md) - [Create a storage group](https://techdocs.akamai.com/netstorage/docs/create-a-storage-group.md) - [Create an upload account](https://techdocs.akamai.com/netstorage/docs/create-an-upload-account.md) - [Configure your access method](https://techdocs.akamai.com/netstorage/docs/access-methods.md) - [Configure secure SSH access methods](https://techdocs.akamai.com/netstorage/docs/configure-secure-ssh-access-methods.md) - [Aspera Upload Acceleration](https://techdocs.akamai.com/netstorage/docs/aspera-upload-acceleration.md) - [File Manager](https://techdocs.akamai.com/netstorage/docs/file-manager.md) - [File Transfer Protocol](https://techdocs.akamai.com/netstorage/docs/file-transfer-protocol.md) - [NetStorage Usage API](https://techdocs.akamai.com/netstorage/docs/the-netstorage-usage-api-1.md) - [Rsync](https://techdocs.akamai.com/netstorage/docs/rsync.md) - [Create an ACL rule set](https://techdocs.akamai.com/netstorage/docs/acl-rule-sets.md) - [Create a NetStorage alert](https://techdocs.akamai.com/netstorage/docs/create-a-netstorage-alert.md) - [Upload content to NetStorage](https://techdocs.akamai.com/netstorage/docs/upload-content.md) - [Delete a storage group](https://techdocs.akamai.com/netstorage/docs/delete-a-storage-group.md) - [Delete an upload directory](https://techdocs.akamai.com/netstorage/docs/delete-an-upload-directory.md) - [Create a site snapshot](https://techdocs.akamai.com/netstorage/docs/create-a-site-snapshot.md) - [Manage content](https://techdocs.akamai.com/netstorage/docs/manage-content-access-methods.md) - [Use Aspera Upload Acceleration](https://techdocs.akamai.com/netstorage/docs/use-aspera-upload-acceleration.md) - [Use File Manager](https://techdocs.akamai.com/netstorage/docs/use-file-manager.md) - [Use File Transfer Protocol](https://techdocs.akamai.com/netstorage/docs/use-file-transfer-protocol.md) - [Use Rclone](https://techdocs.akamai.com/netstorage/docs/use-rclone.md) - [Use Rsync](https://techdocs.akamai.com/netstorage/docs/use-rsync.md) - [Use Secure Copy](https://techdocs.akamai.com/netstorage/docs/use-secure-copy.md) - [Use SSH File Transfer Protocol (SFTP)](https://techdocs.akamai.com/netstorage/docs/use-sftp.md) - [Use the Content Management Shell (CMShell)](https://techdocs.akamai.com/netstorage/docs/use-the-content-management-shell.md) - [Serve content from zip files](https://techdocs.akamai.com/netstorage/docs/serve-content-from-zip-files.md) - [NetStorage CLI](https://techdocs.akamai.com/netstorage/docs/netstorage-cli.md) - [Integrate security](https://techdocs.akamai.com/netstorage/docs/how-to-integrate-security.md) - [Maximize upload performance](https://techdocs.akamai.com/netstorage/docs/how-to-maximize-upload-performance.md) - [Download with NetStorage](https://techdocs.akamai.com/netstorage/docs/downloads-with-netstorage.md) - [Advice for specific use cases](https://techdocs.akamai.com/netstorage/docs/advice-for-specific-use-cases.md) - [Geographic replication impacts transfers](https://techdocs.akamai.com/netstorage/docs/geographic-replication-impacts-transfers.md) - [User-generated content (UGC)](https://techdocs.akamai.com/netstorage/docs/user-generated-content-ugc.md) - [Welcome to NetStorage Reports](https://techdocs.akamai.com/netstorage/docs/welcome-to-netstorage-reports.md) - [Technical limits with NetStorage](https://techdocs.akamai.com/netstorage/docs/technical-limits-with-netstorage.md) - [Supported MIME types](https://techdocs.akamai.com/netstorage/docs/supported-mime-types.md) - [Activation and completion times](https://techdocs.akamai.com/netstorage/docs/activation-times.md) ## API Reference - [NetStorage Configuration API](https://techdocs.akamai.com/netstorage/reference/api.md) - [Get started](https://techdocs.akamai.com/netstorage/reference/get-started.md) - [Concepts](https://techdocs.akamai.com/netstorage/reference/api-concepts.md) - [Rate limiting](https://techdocs.akamai.com/netstorage/reference/rate-limiting.md) - [API hypermedia](https://techdocs.akamai.com/netstorage/reference/api-hypermedia.md) - [Enumerations](https://techdocs.akamai.com/netstorage/reference/enumerations.md) - [Errors](https://techdocs.akamai.com/netstorage/reference/errors.md) - [400](https://techdocs.akamai.com/netstorage/reference/400.md) - [401](https://techdocs.akamai.com/netstorage/reference/401.md) - [403](https://techdocs.akamai.com/netstorage/reference/403.md) - [429](https://techdocs.akamai.com/netstorage/reference/429.md) - [Create a CP code](https://techdocs.akamai.com/netstorage/reference/post-cpcodes.md): This operation creates a CP code for use with NetStorage. - [List unused CP Codes](https://techdocs.akamai.com/netstorage/reference/get-cpcodes-unused.md): Get a list of CP codes that aren't assigned to a storage group. - [List CP codes in use](https://techdocs.akamai.com/netstorage/reference/get-cpcodes-used.md): Get a list of all CP codes that are assigned to a storage group. - [Delete an automatic purge routine](https://techdocs.akamai.com/netstorage/reference/delete-cpcode-age-deletions.md): Delete the automatic purge routine for a specific CP code. - [View the automatic purge routine](https://techdocs.akamai.com/netstorage/reference/get-cpcode-age-deletions.md): View the automatic purge routines for a `cpcodeId`. You can optionally include a URL-encoded `ageDeletionDirectoryPrefix` to filter an individual purge routine. - [Modify a purge routine](https://techdocs.akamai.com/netstorage/reference/put-cpcode-age-deletions.md): Make changes to an automatic purge routine for a specific CP code. - [Create a storage group](https://techdocs.akamai.com/netstorage/reference/post-storage-groups.md): This operation creates a new storage group to house your content. - [List storage groups](https://techdocs.akamai.com/netstorage/reference/get-storage-groups.md): Get a list of all of the storage groups in your NetStorage instance, optionally filtered by CP code or the storage group's categorized purpose. - [Get a storage group](https://techdocs.akamai.com/netstorage/reference/get-storage-group.md): Get a specific storage group based on its `storageGroupId`. - [Edit a storage group](https://techdocs.akamai.com/netstorage/reference/put-storage-group.md): Update storage group based on its unique ID value. - [List upload accounts](https://techdocs.akamai.com/netstorage/reference/get-upload-accounts.md): Get a list of upload accounts for all storage groups in your NetStorage instance. - [Create a new upload account](https://techdocs.akamai.com/netstorage/reference/post-upload-accounts.md): Create an upload account for a storage group. - [Get an upload account](https://techdocs.akamai.com/netstorage/reference/get-upload-account.md): Get a specific upload account based on its unique ID value. - [Edit an upload account](https://techdocs.akamai.com/netstorage/reference/put-upload-account.md): Update an upload account based on its `uploadAccountId`. - [Disable an upload account](https://techdocs.akamai.com/netstorage/reference/post-upload-account-disable.md): Disable an upload account based on its `uploadAccountId`. - [Enable an upload account](https://techdocs.akamai.com/netstorage/reference/post-upload-account-enable.md): Enable an upload account based on its `uploadAccountId`. - [Add keys to an FTP upload account](https://techdocs.akamai.com/netstorage/reference/put-upload-account-keys-ftp.md): Add keys to an FTP upload account based on its `uploadAccountId`. - [Enable an upload account's FTP keys](https://techdocs.akamai.com/netstorage/reference/post-upload-account-keys-ftp-identity.md): Enable an upload account's FTP Keys based on its `uploadAccountId` and FTP `identity`. - [Update an upload account's FTP keys](https://techdocs.akamai.com/netstorage/reference/put-upload-account-keys-ftp-identity.md): Save an upload account's FTP keys based on its `uploadAccountId` and FTP `identity`. - [Delete an upload account's FTP keys](https://techdocs.akamai.com/netstorage/reference/delete-upload-account-keys-ftp-identity.md): Delete an upload account's FTP keys based on its `uploadAccountId` and FTP `identity`. - [Disable an upload account's FTP keys](https://techdocs.akamai.com/netstorage/reference/post-upload-account-keys-ftp-identity-disable.md): Disable an upload account's FTP keys based on its `uploadAccountId` and FTP `identity`. - [Extend your FTP password](https://techdocs.akamai.com/netstorage/reference/post-upload-account-keys-ftp-identity-extend.md): Extend your FTP password for an additional 120 days. - [Save an upload account's rsync keys](https://techdocs.akamai.com/netstorage/reference/put-upload-account-keys-rsync.md): Save an upload account's rsync keys based on its unique uploadAccountId. - [Delete all rsync keys for an upload account](https://techdocs.akamai.com/netstorage/reference/delete-upload-account-keys-rsync.md): Delete all rsync keys assigned to an upload account. - [Delete a specific rsync key](https://techdocs.akamai.com/netstorage/reference/delete-upload-account-keys-rsync-identity.md): Delete an upload account's rsync keys based on its `uploadAccountId` and rsync `identity`. - [Disable an upload account's rsync keys](https://techdocs.akamai.com/netstorage/reference/post-upload-account-keys-rsync-identity-disable.md): Disable an upload account's rsync keys based on its `uploadAccountId` and rsync `identity`. - [Enable an upload account's rsync keys](https://techdocs.akamai.com/netstorage/reference/post-upload-account-keys-rsync-identity-enable.md): Enable an upload account's rsync keys based on its `uploadAccountId` and rsync `identity`. - [Add SSH keys to an upload account](https://techdocs.akamai.com/netstorage/reference/put-upload-account-keys-ssh.md): Add SSH keys to an upload account based on its `uploadAccountId`. - [Delete an upload account's SSH keys](https://techdocs.akamai.com/netstorage/reference/delete-upload-account-keys-ssh-identity.md): Delete an upload account's SSH keys based on its `uploadAccountId` and SSH `identity`. - [Disable an upload account's SSH keys](https://techdocs.akamai.com/netstorage/reference/post-upload-account-keys-ssh-identity-disable.md): Disable an upload account's SSH keys based on its `uploadAccountId` and SSH `identity`. - [Enable an upload account's SSH keys](https://techdocs.akamai.com/netstorage/reference/post-upload-account-keys-ssh-identity-enable.md): Enable an upload account's SSH keys based on its `uploadAccountId` and SSH `identity`. - [Add G2O keys to an upload account](https://techdocs.akamai.com/netstorage/reference/put-upload-account-keys-g2o.md): Add G2O keys upload account based on its `uploadAccountId`. - [Delete an upload account's G2O keys](https://techdocs.akamai.com/netstorage/reference/delete-upload-account-keys-g2o-identity.md): Delete an upload account's G2O keys based on its `uploadAccountId` and G2O `identity`. - [Disable an upload account's G2O keys](https://techdocs.akamai.com/netstorage/reference/post-upload-account-keys-g2o-identity-disable.md): Disable an upload account's G2O keys based on its `uploadAccountId` and G2O `identity`. - [Enable an upload account's G2O keys](https://techdocs.akamai.com/netstorage/reference/post-upload-account-keys-g2o-identity-enable.md): Enable an upload account's G2O keys based on its `uploadAccountId` and G2O `identity`. - [List zones](https://techdocs.akamai.com/netstorage/reference/get-zones.md): Get a list of the geographic regions (*zones*) you can use to replicate your content. - [List all rule sets](https://techdocs.akamai.com/netstorage/reference/get-rule-sets.md): Get a list of rule sets. - [Create a rule set](https://techdocs.akamai.com/netstorage/reference/post-rule-sets.md): Create a rule set. - [Delete a rule set](https://techdocs.akamai.com/netstorage/reference/delete-rule-set.md): Delete a specified rule set. - [Get a rule set](https://techdocs.akamai.com/netstorage/reference/get-rule-set.md): Get details for a specific rule set. - [Update a rule set](https://techdocs.akamai.com/netstorage/reference/put-rule-set.md): Update a specific rule set. - [List all site snapshots](https://techdocs.akamai.com/netstorage/reference/get-snapshots.md): Get a list of all site snapshots. - [Create a site snapshot](https://techdocs.akamai.com/netstorage/reference/post-snapshots.md): Use this operation to create a new site snapshot configuration. - [Create an immediate site snapshot](https://techdocs.akamai.com/netstorage/reference/post-snapshots-schedule-now.md): Create an immediate snapshot for a `snapshotId` and `snapshotName` you provide. - [Delete a site snapshot](https://techdocs.akamai.com/netstorage/reference/delete-snapshot.md): Use this operation to delete a specific site snapshot configuration using its `snapshotId`. - [Get a site snapshot schedule](https://techdocs.akamai.com/netstorage/reference/get-snapshot.md): Get the site snapshot schedule for a `snapshotId`. - [Update a site snapshot schedule](https://techdocs.akamai.com/netstorage/reference/put-snapshot.md): Update a site snapshot schedule for a `snapshotId`. ## Recipes - [Create a NetStorage CP code](https://techdocs.akamai.com/netstorage/recipes/create-a-netstorage-cp-code.md) - [Create a "serve from zip" compatible archive](https://techdocs.akamai.com/netstorage/recipes/create-a-serve-from-zip-compatible-archive.md) - [Create a storage group](https://techdocs.akamai.com/netstorage/recipes/create-a-storage-group.md) - [Create an upload account](https://techdocs.akamai.com/netstorage/recipes/create-an-upload-account.md) - [Example OpenSSH CMShell connection](https://techdocs.akamai.com/netstorage/recipes/example-openssh-cmshell-connection.md) - [Example OpenSSH SFTP connection](https://techdocs.akamai.com/netstorage/recipes/example-openssh-sftp-connection.md) - [Get a storage group](https://techdocs.akamai.com/netstorage/recipes/get-a-storage-group.md) - [Get an upload account](https://techdocs.akamai.com/netstorage/recipes/get-an-upload-account.md) - [List replication zones](https://techdocs.akamai.com/netstorage/recipes/list-replication-zones.md) - [List storage groups](https://techdocs.akamai.com/netstorage/recipes/list-storage-groups.md) - [List unused NetStorage CP codes](https://techdocs.akamai.com/netstorage/recipes/list-unused-netstorage-cp-codes.md) - [List upload accounts](https://techdocs.akamai.com/netstorage/recipes/list-upload-accounts.md) - [List used NetStorage CP codes](https://techdocs.akamai.com/netstorage/recipes/list-used-netstorage-cp-codes.md) - [Update a storage group](https://techdocs.akamai.com/netstorage/recipes/update-a-storage-group.md) - [Update an upload account](https://techdocs.akamai.com/netstorage/recipes/update-an-upload-account.md) - [Upload a single file with SFTP](https://techdocs.akamai.com/netstorage/recipes/upload-a-single-file-with-sftp.md) ## Changelog - [Apr 15, 2024 — Updated Aspera client support](https://techdocs.akamai.com/netstorage/changelog/aspera-client-support.md) - [Dec 2, 2021 — New NetStorage documentation experience](https://techdocs.akamai.com/netstorage/changelog/dec-2021-new-netstorage-documentation-experience.md) - [Jan 22, 2021 — Improved email notifications](https://techdocs.akamai.com/netstorage/changelog/jan-22-2021-improved-email-notifications.md) - [Aug 26, 2020 — Updated navigation in Control Center](https://techdocs.akamai.com/netstorage/changelog/aug-26-2020-updated-navigation-in-control-center.md) - [Aug 5, 2020 — Support for editing Auto Purge settings](https://techdocs.akamai.com/netstorage/changelog/aug-5-2020-support-for-editing-auto-purge-settings.md) # NetStorage Usage API Documentation > Akamai's NetStorage Usage API provides HTTP methods you can use to manage your NetStorage content. Communication is conducted via the Edge network using a HTTP(S) client of your own design. The client could be a web-based browser or scripted tools integrated with your content management system so long as each request provides the required NetStorage HTTP headers. With it, you can perform operations such as uploading, deleting, and listing of content, thus providing you another option for interfacing with your NetStorage account. HTTPS with Transport Layer Security (TLS) can be used. ## API Reference - [NetStorage Usage API](https://techdocs.akamai.com/netstorage-usage/reference/api.md) - [Key concepts and terms](https://techdocs.akamai.com/netstorage-usage/reference/key-concepts-and-terms.md) - [Get started](https://techdocs.akamai.com/netstorage-usage/reference/get-started.md) - [Parse XML responses](https://techdocs.akamai.com/netstorage-usage/reference/parse-xml-responses.md) - [Format an API call](https://techdocs.akamai.com/netstorage-usage/reference/format-an-api-call.md) - [Example authentication headers](https://techdocs.akamai.com/netstorage-usage/reference/example-authentication-headers.md) - [Each call needs signature header authentication](https://techdocs.akamai.com/netstorage-usage/reference/each-call-needs-signature-header-authentication.md) - [Errors](https://techdocs.akamai.com/netstorage-usage/reference/errors.md) - [400](https://techdocs.akamai.com/netstorage-usage/reference/400.md) - [403](https://techdocs.akamai.com/netstorage-usage/reference/403.md) - [404](https://techdocs.akamai.com/netstorage-usage/reference/404.md) - [412](https://techdocs.akamai.com/netstorage-usage/reference/412.md) - [429](https://techdocs.akamai.com/netstorage-usage/reference/429.md) - [500](https://techdocs.akamai.com/netstorage-usage/reference/500.md) - [delete action](https://techdocs.akamai.com/netstorage-usage/reference/put-delete.md): Use this action to delete content from your storage group. - [Usage details for "delete"](https://techdocs.akamai.com/netstorage-usage/reference/usage-details-for-delete.md) - [dir action](https://techdocs.akamai.com/netstorage-usage/reference/get-dir.md): Use the `dir` action to list the objects directly within the specified directory, similar to a standard `ls` or `dir` command. - [Usage details for "dir"](https://techdocs.akamai.com/netstorage-usage/reference/usage-details-for-dir.md) - [download action](https://techdocs.akamai.com/netstorage-usage/reference/get-download.md): Use this action to download a specified file from a NetStorage storage group. - [Usage details for "download"](https://techdocs.akamai.com/netstorage-usage/reference/usage-details-for-download.md) - [du action](https://techdocs.akamai.com/netstorage-usage/reference/get-du.md): Use this action to return disk usage information for a specified directory in a NetStorage storage group. - [list action](https://techdocs.akamai.com/netstorage-usage/reference/get-list.md): Use this action to list the objects directly within the specified directory, similar to a standard `ls` or `dir` command. - [mkdir action](https://techdocs.akamai.com/netstorage-usage/reference/put-mkdir.md): You can use the `mkdir` action to create a new [explicit directory](https://techdocs.akamai.com/netstorage/docs/netstorage-file-structure#implicit-vs-explicit-directories) in a storage group. - [Usage details for "mkdir"](https://techdocs.akamai.com/netstorage-usage/reference/usage-details-for-mkdir.md) - [mtime action](https://techdocs.akamai.com/netstorage-usage/reference/post-mtime.md): Use the `mtime` action to change a the modification time ("touch") of a storage group object. - [quick-delete action](https://techdocs.akamai.com/netstorage-usage/reference/post-quick-delete.md): You can use `quick-delete` to perform a delete of a selected directory, including all contents. - [Usage details for "quick-delete"](https://techdocs.akamai.com/netstorage-usage/reference/usage-details-for-quick-delete.md) - [rename action](https://techdocs.akamai.com/netstorage-usage/reference/put-rename.md): You can use the `rename` action to target a specific file or symbolic link in order to rename it. - [Usage details for "rename"](https://techdocs.akamai.com/netstorage-usage/reference/you-can-move-a-file-with-the-rename-action.md) - [rmdir action](https://techdocs.akamai.com/netstorage-usage/reference/put-rmdir.md): Use this action to delete an empty directory. - [Usage details for "rmdir"](https://techdocs.akamai.com/netstorage-usage/reference/usage-details-for-rmdir.md) - [stat action](https://techdocs.akamai.com/netstorage-usage/reference/get-stat.md): Use this action to view the stat structure (information) for a named file, symlink, or directory. - [Usage details for "stat"](https://techdocs.akamai.com/netstorage-usage/reference/usage-details-for-stat.md) - [symlink action](https://techdocs.akamai.com/netstorage-usage/reference/post-symlink.md): You can create a symbolic link using this action. - [Usage details for "symlink"](https://techdocs.akamai.com/netstorage-usage/reference/usage-details-for-symlink.md) - [upload action](https://techdocs.akamai.com/netstorage-usage/reference/put-upload.md): You can upload files to a storage group with the `upload` action. You need to include "non-empty" header content to serve as the `[Body]` for an "upload" action. - [Usage details for "upload"](https://techdocs.akamai.com/netstorage-usage/reference/usage-details-for-upload.md) ## Recipes - [Delete content from a storage group](https://techdocs.akamai.com/netstorage-usage/recipes/delete-content-from-a-storage-group.md) - [Download a file](https://techdocs.akamai.com/netstorage-usage/recipes/download-a-file.md) - [List content in a directory](https://techdocs.akamai.com/netstorage-usage/recipes/list-content-in-a-directory.md) - [Make a new directory](https://techdocs.akamai.com/netstorage-usage/recipes/make-a-new-directory.md) - [Perform a quick-delete](https://techdocs.akamai.com/netstorage-usage/recipes/perform-a-quick-delete.md) - [Rename and object](https://techdocs.akamai.com/netstorage-usage/recipes/rename-and-object.md) - [Set a the modification time of an object](https://techdocs.akamai.com/netstorage-usage/recipes/set-a-the-modification-time-of-an-object.md) - [View disk usage](https://techdocs.akamai.com/netstorage-usage/recipes/view-disk-usage.md) - [View the contents of a directory](https://techdocs.akamai.com/netstorage-usage/recipes/view-the-contents-of-a-directory.md) ## Changelog - [Mar 16, 2022 — New NetStorage Usage API documentation experience](https://techdocs.akamai.com/netstorage-usage/changelog/mar-16-2022-new-netstorage-usage-api-documentation-experience.md) # Network Lists API Documentation > Manage common sets of lists used by various Akamai security products and features. ## API Reference - [Network Lists API](https://techdocs.akamai.com/network-lists/reference/api.md) - [API summary](https://techdocs.akamai.com/network-lists/reference/api-summary.md) - [Get started](https://techdocs.akamai.com/network-lists/reference/api-get-started.md) - [Concurrency control](https://techdocs.akamai.com/network-lists/reference/concurrency-control.md) - [Partial GET and PUT options](https://techdocs.akamai.com/network-lists/reference/partial-get-and-put-options.md) - [API hypermedia](https://techdocs.akamai.com/network-lists/reference/api-hypermedia.md) - [Rate limits](https://techdocs.akamai.com/network-lists/reference/rate-limits.md) - [Activation states](https://techdocs.akamai.com/network-lists/reference/activation-states.md) - [Errors](https://techdocs.akamai.com/network-lists/reference/api-errors.md) - [400](https://techdocs.akamai.com/network-lists/reference/400.md) - [401](https://techdocs.akamai.com/network-lists/reference/401.md) - [403](https://techdocs.akamai.com/network-lists/reference/403.md) - [404](https://techdocs.akamai.com/network-lists/reference/404.md) - [409](https://techdocs.akamai.com/network-lists/reference/409.md) - [500](https://techdocs.akamai.com/network-lists/reference/500.md) - [List network lists](https://techdocs.akamai.com/network-lists/reference/get-network-lists.md): List all network lists available for an authenticated user who belongs to a group, optionally filtered by `listType` or based on a `search` string. Results appear within the `networkLists` array, which might be empty if no network lists are available to the client. - [Create a new network list](https://techdocs.akamai.com/network-lists/reference/post-network-lists.md): Creates a new network list. - [Delete a network list](https://techdocs.akamai.com/network-lists/reference/delete-network-list.md): Removes a network list. You can only remove network lists that never activated. To deactivate a list, you can empty out its `list` of elements. - [Get a network list](https://techdocs.akamai.com/network-lists/reference/get-network-list.md): Gets a network list's most recent `syncPoint` version. - [Update a network list](https://techdocs.akamai.com/network-lists/reference/put-network-list.md): Modify the network list items and properties. Allows you to set the name, description and set of network list items to the resource. The current state of the list will be replaced with the properties and items you provide. The type cannot be changed. - [Append elements to a network list](https://techdocs.akamai.com/network-lists/reference/post-network-list-append.md): Appends a set of elements to a network list. If the networks list's `type` is `IP`, the submitted `list` is a series of IP addresses or CIDR blocks. If the type is `GEO`, it's a set of two-character country codes. (See the [EdgeScape Documentation](https://control.akamai.com/apps/download-center/#/products/3;name=EdgeScape) for more information. For a list of countries, go to __Data Codes__ ⇒ __Country Code__.) - [Update network list details](https://techdocs.akamai.com/network-lists/reference/put-network-list-details.md): Update a network list's name or description. - [Remove an element](https://techdocs.akamai.com/network-lists/reference/delete-network-list-elements.md): Removes the specified `element` from the list. If the network list's `type` is `IP`, the value is a URL-encoded IP address or CIDR block. If the type is `GEO`, it's a two-character country code. - [Add an element](https://techdocs.akamai.com/network-lists/reference/put-network-list-elements.md): Adds the specified `element` to the list. If the network list's `type` is `IP`, the value needs to be a URL-encoded IP address or CIDR block. If the type is `GEO`, it's a two-character country code. (See the [EdgeScape Documentation](https://control.akamai.com/apps/download-center/#/products/3;name=EdgeScape)) for more information. For a list of countries, go to __Data Codes__ ⇒ __Country Code__.) - [Activate a network list](https://techdocs.akamai.com/network-lists/reference/post-network-list-activate.md): Activate the most recent `syncPoint` version of a network list in either the `STAGING` or `PRODUCTION` environment. - [Get activation status](https://techdocs.akamai.com/network-lists/reference/get-network-list-status.md): Shows a network list's activation status on either the `STAGING` or `PRODUCTION` environment. The response reflects standard activation status. For fast activation status, see [Get activation details](ref:get-activation). - [Get an activation's snapshot](https://techdocs.akamai.com/network-lists/reference/get-network-list-history.md): Gets a version of a network list in its state when activated, with each version identified by its `syncPoint` value. You can only get `syncPoint` versions that have been activated. - [Get activation details](https://techdocs.akamai.com/network-lists/reference/get-activation.md): Provides detailed status for a given activation, including progress on _fast_ activation and other audit information, in addition to information ordinarily available from the [Get activation status](ref:get-network-list-status) operation. - [Subscribe to network lists](https://techdocs.akamai.com/network-lists/reference/post-notifications-subscribe.md): Specifies a set of email addresses to inform Control Center account recipients about changes to a set of network lists. - [Unsubscribe to network lists](https://techdocs.akamai.com/network-lists/reference/post-notifications-unsubscribe.md): Unsubscribes the listed users from a set of network lists. ## Changelog - [Jan 5, 2022 — New Network Lists API documentation experience](https://techdocs.akamai.com/network-lists/changelog/jan-5-2022-new-network-lists-api-documentation-experience.md) # Object Delivery Documentation > Akamai's Object Delivery service brings scalability, speed, and availability to the delivery of embedded static content. It removes the need to offload your entire website, which will improve its overall performance. It optimizes availability and delivery from your subdomain of executables over HTTP that are less than 100 MB, such as images, JavaScript, CSS, PDF documents, and XML. It does this while offering configuration options for cacheability and other services that help offload your origin infrastructure. ## Guides - [Welcome to Object Delivery](https://techdocs.akamai.com/object-delivery/docs/welcome-object-delivery.md) - [Delivery concepts and terms](https://techdocs.akamai.com/object-delivery/docs/delivery-concepts-and-terms.md) - [Get your unique information](https://techdocs.akamai.com/object-delivery/docs/get-environmental-information.md) - [Understand the request flow](https://techdocs.akamai.com/object-delivery/docs/understand-the-request-flow.md) - [Prepare your environment](https://techdocs.akamai.com/object-delivery/docs/prepare-your-environment.md) - [Create an Object Delivery property](https://techdocs.akamai.com/object-delivery/docs/create-new-prop.md) - [Define property hostnames](https://techdocs.akamai.com/object-delivery/docs/define-prop-hn.md) - [Define property variables (optional)](https://techdocs.akamai.com/object-delivery/docs/define-property-variables-optional.md) - [Define property configuration settings](https://techdocs.akamai.com/object-delivery/docs/define-property-configuration-settings.md) - [Default optimizations](https://techdocs.akamai.com/object-delivery/docs/best-practices-and-use-case-based-provisioning.md) - [Origin Characteristics & Object Delivery](https://techdocs.akamai.com/object-delivery/docs/origin-characteristics-and-od.md) - [Content Characteristics & Object Delivery](https://techdocs.akamai.com/object-delivery/docs/content-characteristics-and-od.md) - [Client Characteristics & Object Delivery](https://techdocs.akamai.com/object-delivery/docs/client-characteristics-and-od.md) - [Object Caching & Object Delivery](https://techdocs.akamai.com/object-delivery/docs/object-caching-and-od.md) - [Origin Server & Object Delivery](https://techdocs.akamai.com/object-delivery/docs/origin-server-and-od.md) - [Content Provider Code & Object Delivery](https://techdocs.akamai.com/object-delivery/docs/content-provider-code-and-od.md) - [Quick Retry & Object Delivery](https://techdocs.akamai.com/object-delivery/docs/quick-retry-and-od.md) - [Recommended behaviors in the Default Rule](https://techdocs.akamai.com/object-delivery/docs/recommended-behaviors-in-the-default-rule.md) - [Optional behaviors in the Default Rule](https://techdocs.akamai.com/object-delivery/docs/optal-behs-default-rule.md) - [Add optional rules](https://techdocs.akamai.com/object-delivery/docs/add-optional-rules.md) - [Finalize your Object Delivery property](https://techdocs.akamai.com/object-delivery/docs/finalize-your-od-property.md) - [Test your Object Delivery property](https://techdocs.akamai.com/object-delivery/docs/test-your-od-property.md) - [Go live with Object Delivery](https://techdocs.akamai.com/object-delivery/docs/go-live.md) - [Auth Token 2.0 Verification](https://techdocs.akamai.com/object-delivery/docs/add-auth-token-20-verification.md) - [Breadcrumbs](https://techdocs.akamai.com/object-delivery/docs/add-breadcrumbs.md) - [Client Hints](https://techdocs.akamai.com/object-delivery/docs/client-hints.md) - [Cloud Access Manager](https://techdocs.akamai.com/object-delivery/docs/add-cloud-access-manager.md) - [Cloud Wrapper](https://techdocs.akamai.com/object-delivery/docs/cloud-wrapper.md) - [Early Data (0-RTT)](https://techdocs.akamai.com/object-delivery/docs/early-data-0-rtt.md) - [Edge IP Binding](https://techdocs.akamai.com/object-delivery/docs/add-edge-ip-binding.md) - [EdgeWorkers](https://techdocs.akamai.com/object-delivery/docs/add-edgeworkers.md) - [Enhanced Debug](https://techdocs.akamai.com/object-delivery/docs/enhanced-debug.md) - [Enhanced Proxy Detection](https://techdocs.akamai.com/object-delivery/docs/add-enhanced-proxy-detection.md) - [HTTP to HTTPS Upgrade](https://techdocs.akamai.com/object-delivery/docs/upgrade-req-http-https.md) - [Mixed Mode](https://techdocs.akamai.com/object-delivery/docs/use-mixed-mode-with-od.md) - [Separate origins and different auth methods](https://techdocs.akamai.com/object-delivery/docs/separate-origins-and-different-auth-methods.md) - [Different Client and Content Characteristics](https://techdocs.akamai.com/object-delivery/docs/different-client-and-content-characteristics.md) - [Known limitations with MMC](https://techdocs.akamai.com/object-delivery/docs/known-limitations-with-mmc.md) - [Origin IP access control list](https://techdocs.akamai.com/object-delivery/docs/origin-ip-access-control-list-object-delivery.md) - [Protect connections with mTLS](https://techdocs.akamai.com/object-delivery/docs/protect-connections-with-mtls.md) - [Protocol Downgrade](https://techdocs.akamai.com/object-delivery/docs/add-protocol-downgrade.md) - [The legacy Protocol Downgrade behavior](https://techdocs.akamai.com/object-delivery/docs/the-legacy-protocol-downgrade-behavior.md) - [No PII content](https://techdocs.akamai.com/object-delivery/docs/no-pii-content.md) - [Add the Protocol Downgrade behavior](https://techdocs.akamai.com/object-delivery/docs/add-the-protocol-downgrade-behavior.md) - [Quick Retry](https://techdocs.akamai.com/object-delivery/docs/add-quick-retry.md) - [The Vary HTTP header](https://techdocs.akamai.com/object-delivery/docs/include-the-vary-http-header.md) - [View reports for Object Delivery](https://techdocs.akamai.com/object-delivery/docs/view-reports.md) - [Object Delivery service-level agreement](https://techdocs.akamai.com/object-delivery/docs/service-level-agreement-for-od.md) ## API Reference - [APIs and Object Delivery](https://techdocs.akamai.com/object-delivery/reference/apis-and-object-delivery.md) ## Changelog - [Oct 8, 2024 – Update to Origin IP ACL support](https://techdocs.akamai.com/object-delivery/changelog/oct-8-2024-update-to-origin-ip-acl-support.md) - [Sep 30, 2024 – New Enhanced Debug and Early Data behaviors](https://techdocs.akamai.com/object-delivery/changelog/sep-30-2024-new-enhanced-debug-and-early-data-behaviors.md) - [Jan 11, 2024 – Client Hints support](https://techdocs.akamai.com/object-delivery/changelog/jan-11-2024-client-hints-support.md) - [Dec 18, 2023 — Support for mTLS](https://techdocs.akamai.com/object-delivery/changelog/dec-18-2023-support-for-mtls.md) - [Nov 7, 2023 – Origin IP ACL](https://techdocs.akamai.com/object-delivery/changelog/nov-7-2023-origin-ip-acl.md) # Origin IP Access Control List Documentation > Origin IP Access Control List helps to protect your origin server by restricting access to a small and stable list of IP addresses. ## Guides - [Welcome to Origin IP ACL](https://techdocs.akamai.com/origin-ip-acl/docs/welcome.md) - [Update your origin server](https://techdocs.akamai.com/origin-ip-acl/docs/update-your-origin-server.md) - [Set up Origin IP ACL](https://techdocs.akamai.com/origin-ip-acl/docs/set-up-origin-ip-acl.md) - [Caveats and recommendations](https://techdocs.akamai.com/origin-ip-acl/docs/recommendations-and-caveats.md) - [Migrate from Site Shield to Origin IP ACL](https://techdocs.akamai.com/origin-ip-acl/docs/migrate-from-site-shield-to-origin-ip-acl.md) # PowerShell Documentation > Make calls to many of our API with a consistent interface using our PowerShell module. ## Guides - [Overview](https://techdocs.akamai.com/powershell/docs/overview.md): Install Akamai PowerShell to manage Akamai services with a single toolset - [Authentication](https://techdocs.akamai.com/powershell/docs/authentication.md): Get authentication for Akamai API - [Base IDs](https://techdocs.akamai.com/powershell/docs/base-ids.md): Get base IDs for your Akamai account - [Version Mapping](https://techdocs.akamai.com/powershell/docs/version-mapping.md) - [Error handling and options](https://techdocs.akamai.com/powershell/docs/error-handling-and-options.md) - [Commands and help](https://techdocs.akamai.com/powershell/docs/commands-help.md) - [Code and tests](https://techdocs.akamai.com/powershell/docs/code-tests.md) - [Function index](https://techdocs.akamai.com/powershell/docs/api-def-index.md) - [Endpoint](https://techdocs.akamai.com/powershell/docs/copy-apiendpoint.md): Copy-APIEndpoint - [API operation](https://techdocs.akamai.com/powershell/docs/find-apioperation.md): Find-APIOperation - [Category](https://techdocs.akamai.com/powershell/docs/get-apicategory.md): Get-APICategory - [Contracts & groups](https://techdocs.akamai.com/powershell/docs/get-apicontractsandgroups.md): Get-APIContractsAndGroups - [Endpoint](https://techdocs.akamai.com/powershell/docs/get-apiendpoint.md): Get-APIEndpoint - [Endpoint multistep group](https://techdocs.akamai.com/powershell/docs/get-apiendpointmultistepgroup.md) - [Endpoint version](https://techdocs.akamai.com/powershell/docs/get-apiendpointversion.md): Get-APIEndpointVersion - [Endpoint version cache](https://techdocs.akamai.com/powershell/docs/get-apiendpointversioncache.md): Get-APIEndpointVersionCache - [Endpoint version CORS](https://techdocs.akamai.com/powershell/docs/get-apiendpointversioncors.md): Get-APIEndpointVersionCORS - [Endpoint version error responses](https://techdocs.akamai.com/powershell/docs/get-apiendpointversionerrorresponses.md): Get-APIEndpointVersionErrorResponses - [Endpoint version error response type](https://techdocs.akamai.com/powershell/docs/get-apiendpointversionerrorresponsetype.md): Get-APIEndpointVersionErrorResponseType - [Endpoint version GraphQL](https://techdocs.akamai.com/powershell/docs/get-apiendpointversiongraphql.md): Get-APIEndpointVersionGraphQL - [Endpoint version GZIP](https://techdocs.akamai.com/powershell/docs/get-apiendpointversiongzip.md): Get-APIEndpointVersionGZip - [Endpoint version JWT](https://techdocs.akamai.com/powershell/docs/get-apiendpointversionjwt.md): Get-APIEndpointVersionJWT - [Endpoint version PII](https://techdocs.akamai.com/powershell/docs/get-apiendpointversionpii.md): Get-APIEndpointVersionPII - [Endpoint version PII settings](https://techdocs.akamai.com/powershell/docs/get-apiendpointversionpiisettings.md) - [Endpoint version privacy](https://techdocs.akamai.com/powershell/docs/get-apiendpointversionprivacy.md): Get-APIEndpointVersionPrivacy - [Endpoint version resource](https://techdocs.akamai.com/powershell/docs/get-apiendpointversionresource.md): Get-APIEndpointVersionResource - [Endpoint version resource operation](https://techdocs.akamai.com/powershell/docs/get-apiendpointversionresourceoperation.md): Get-APIEndpointVersionResourceOperation - [Endpoint version resources & operations](https://techdocs.akamai.com/powershell/docs/get-apiendpointversionresourcesandoperations.md): Get-APIEndpointVersionResourcesAndOperations - [Endpoint version routing](https://techdocs.akamai.com/powershell/docs/get-apiendpointversionrouting.md): Get-APIEndpointVersionRouting - [Endpoint version summary](https://techdocs.akamai.com/powershell/docs/get-apiendpointversionsummary.md): Get-APIEndpointVersionSummary - [Hostnames](https://techdocs.akamai.com/powershell/docs/get-apihostnames.md): Get-APIHostnames - [Hostnames & groups](https://techdocs.akamai.com/powershell/docs/get-apihostnamesandgroups.md): Get-APIHostnamesAndGroups - [Operations](https://techdocs.akamai.com/powershell/docs/get-apioperations.md): Get-APIOperations - [User entitlements](https://techdocs.akamai.com/powershell/docs/get-apiuserentitlements.md): Get-APIUserEntitlements - [Category](https://techdocs.akamai.com/powershell/docs/new-apicategory.md): New-APICategory - [Endpoint](https://techdocs.akamai.com/powershell/docs/new-apiendpoint.md): New-APIEndpoint - [Endpoint activation](https://techdocs.akamai.com/powershell/docs/new-apiendpointactivation.md): New-APIEndpointActivation - [Endpoint deactivation](https://techdocs.akamai.com/powershell/docs/new-apiendpointdeactivation.md): New-APIEndpointDeactivation - [Endpoint from file](https://techdocs.akamai.com/powershell/docs/new-apiendpointfromfile.md): New-APIEndpointFromFile - [Endpoint multistep group](https://techdocs.akamai.com/powershell/docs/new-apiendpointmultistepgroup.md): New-APIEndpointMultistepGroup - [Endpoint version](https://techdocs.akamai.com/powershell/docs/new-apiendpointversion.md): New-APIEndpointVersion - [Endpoint version resource](https://techdocs.akamai.com/powershell/docs/new-apiendpointversionresource.md): New-APIEndpointVersionResource - [Endpoint version resource operation](https://techdocs.akamai.com/powershell/docs/new-apiendpointversionresourceoperation.md): New-APIEndpointVersionResourceOperation - [Endpoint version PII](https://techdocs.akamai.com/powershell/docs/new-apiendpointversionpii.md): New-APIEndpointVersionPII - [Category](https://techdocs.akamai.com/powershell/docs/remove-apicategory.md): Remove-APICategory - [Endpoint](https://techdocs.akamai.com/powershell/docs/remove-apiendpoint.md): Remove-APIEndpoint - [Endpoint version](https://techdocs.akamai.com/powershell/docs/remove-apiendpointversion.md): Remove-APIEndpointVersion - [Endpoint version PII](https://techdocs.akamai.com/powershell/docs/remove-apiendpointversionpii.md): Remove-APIEndpointVersionPII - [Endpoint version resource](https://techdocs.akamai.com/powershell/docs/remove-apiendpointversionresource.md): Remove-APIEndpointVersionResource - [Endpoint version resource operation](https://techdocs.akamai.com/powershell/docs/remove-apiendpointversionresourceoperation.md): Remove-APIEndpointVersionResourceOperation - [Endpoint multistep group](https://techdocs.akamai.com/powershell/docs/remove-apiendpointmultistepgroup.md): Remove-APIEndpointMultistepGroup - [Endpoint multistep group](https://techdocs.akamai.com/powershell/docs/rename-apiendpointmultistepgroup.md): Rename-APIEndpointMultistepGroup - [Category](https://techdocs.akamai.com/powershell/docs/set-apicategory.md): Set-APICategory - [Endpoint version](https://techdocs.akamai.com/powershell/docs/set-apiendpointversion.md): Set-APIEndpointVersion - [Endpoint version cache](https://techdocs.akamai.com/powershell/docs/set-apiendpointversioncache.md): Set-APIEndpointVersionCache - [Endpoint version CORS](https://techdocs.akamai.com/powershell/docs/set-apiendpointversioncors.md): Set-APIEndpointVersionCORS - [Endpoint version error responses](https://techdocs.akamai.com/powershell/docs/set-apiendpointversionerrorresponses.md): Set-APIEndpointVersionErrorResponses - [Endpoint version error response type](https://techdocs.akamai.com/powershell/docs/set-apiendpointversionerrorresponsetype.md): Set-APIEndpointVersionErrorResponseType - [Endpoint version from file](https://techdocs.akamai.com/powershell/docs/set-apiendpointversionfromfile.md): Set-APIEndpointVersionFromFile - [Endpoint version GraphQL](https://techdocs.akamai.com/powershell/docs/set-apiendpointversiongraphql.md): Set-APIEndpointVersionGraphQL - [Endpoint version GZIP](https://techdocs.akamai.com/powershell/docs/set-apiendpointversiongzip.md): Set-APIEndpointVersionGZip - [Endpoint version JWT](https://techdocs.akamai.com/powershell/docs/set-apiendpointversionjwt.md): Set-APIEndpointVersionJWT - [Endpoint version PII](https://techdocs.akamai.com/powershell/docs/set-apiendpointversionpii.md): Set-APIEndpointVersionPII - [Endpoint version privacy](https://techdocs.akamai.com/powershell/docs/set-apiendpointversionprivacy.md): Set-APIEndpointVersionPrivacy - [Endpoint version PII status](https://techdocs.akamai.com/powershell/docs/set-apiendpointversionpiistatus.md): Set-APIEndpointVersionPIIStatus - [Endpoint version PII settings](https://techdocs.akamai.com/powershell/docs/set-apiendpointversionpiisettings.md) - [Endpoint version resource](https://techdocs.akamai.com/powershell/docs/set-apiendpointversionresource.md): Set-APIEndpointVersionResource - [Endpoint version resource operation](https://techdocs.akamai.com/powershell/docs/set-apiendpointversionresourceoperation.md): Set-APIEndpointVersionResourceOperation - [Endpoint version routing](https://techdocs.akamai.com/powershell/docs/set-apiendpointversionrouting.md): Set-APIEndpointVersionRouting - [Endpoint (hide)](https://techdocs.akamai.com/powershell/docs/hide-apiendpoint.md): Hide-APIEndpoint - [Endpoint version (hide)](https://techdocs.akamai.com/powershell/docs/hide-apiendpointversion.md): Hide-APIEndpointVersion - [Endpoint (show)](https://techdocs.akamai.com/powershell/docs/show-apiendpoint.md): Show-APIEndpoint - [Endpoint version (show)](https://techdocs.akamai.com/powershell/docs/show-apiendpointversion.md): Show-APIEndpointVersion - [Secure connection](https://techdocs.akamai.com/powershell/docs/test-apisecureconnection.md): Test-APISecureConnection - [Operations](https://techdocs.akamai.com/powershell/docs/test-apioperations.md) - [Endpoint version PII](https://techdocs.akamai.com/powershell/docs/update-apiendpointversionpii.md): Update-APIEndpointVersionPII - [Function index](https://techdocs.akamai.com/powershell/docs/api-key-mgr-index.md) - [Keys to collection](https://techdocs.akamai.com/powershell/docs/add-apikeytocollection.md): Add-APIKeyToCollection - [Keys](https://techdocs.akamai.com/powershell/docs/export-apikey.md): Export-APIKey - [Key](https://techdocs.akamai.com/powershell/docs/get-apikey.md): Get-APIKey - [Key collection](https://techdocs.akamai.com/powershell/docs/get-apikeycollection.md): Get-APIKeyCollection - [Key collection ACL](https://techdocs.akamai.com/powershell/docs/get-apikeycollectionacl.md): Get-APIKeyCollectionACL - [Key collection endpoints](https://techdocs.akamai.com/powershell/docs/get-apikeycollectionendpoints.md): Get-APIKeyCollectionEndpoints - [Key collection quota](https://techdocs.akamai.com/powershell/docs/get-apikeycollectionquota.md): Get-APIKeyCollectionQuota - [Tags](https://techdocs.akamai.com/powershell/docs/get-apitag.md): Get-APITag - [Throttling counter](https://techdocs.akamai.com/powershell/docs/get-apithrottlingcounter.md): Get-APIThrottlingCounter - [Throttling counter endpoints](https://techdocs.akamai.com/powershell/docs/get-apithrottlingcounterendpoints.md): Get-APIThrottlingCounterEndpoints - [Throttling counter key collections](https://techdocs.akamai.com/powershell/docs/get-apithrottlingcounterkeycollections.md): Get-APIThrottlingCounterKeyCollections - [Throttling counter keys](https://techdocs.akamai.com/powershell/docs/get-apithrottlingcounterkeys.md): Get-APIThrottlingCounterKeys - [Keys](https://techdocs.akamai.com/powershell/docs/import-apikey.md): Import-APIKey - [Keys](https://techdocs.akamai.com/powershell/docs/move-apikey.md): Move-APIKey - [Keys](https://techdocs.akamai.com/powershell/docs/new-apikey.md): New-APIKey - [Key collection](https://techdocs.akamai.com/powershell/docs/new-apikeycollection.md): New-APIKeyCollection - [Throttling counter](https://techdocs.akamai.com/powershell/docs/new-apithrottlingcounter.md): New-APIThrottlingCounter - [Key collection](https://techdocs.akamai.com/powershell/docs/remove-apikeycollection.md): Remove-APIKeyCollection - [Keys from collection](https://techdocs.akamai.com/powershell/docs/remove-apikeyfromcollection.md): Remove-APIKeyFromCollection - [Throttling counter](https://techdocs.akamai.com/powershell/docs/remove-apithrottlingcounter.md): Remove-APIThrottlingCounter - [Collection key quota](https://techdocs.akamai.com/powershell/docs/reset-apikeycollectionquota.md): Reset-APIKeyCollectionQuota - [Key quota](https://techdocs.akamai.com/powershell/docs/reset-apikeyquota.md): Reset-APIKeyQuota - [Keys](https://techdocs.akamai.com/powershell/docs/restore-apikey.md): Restore-APIKey - [Keys](https://techdocs.akamai.com/powershell/docs/revoke-apikey.md): Revoke-APIKey - [Key](https://techdocs.akamai.com/powershell/docs/set-apikey.md): Set-APIKey - [Key collection](https://techdocs.akamai.com/powershell/docs/set-apikeycollection.md): Set-APIKeyCollection - [Key collection ACL](https://techdocs.akamai.com/powershell/docs/set-apikeycollectionacl.md): Set-APIKeyCollectionACL - [Key collection quota](https://techdocs.akamai.com/powershell/docs/set-apikeycollectionquota.md): Set-APIKeyCollectionQuota - [Throttling counter](https://techdocs.akamai.com/powershell/docs/set-apithrottlingcounter.md): Set-APIThrottlingCounter - [Function index](https://techdocs.akamai.com/powershell/docs/appsec-index.md) - [Policy selected hostnames](https://techdocs.akamai.com/powershell/docs/add-appsecpolicyselectedhostnames.md): Add-AppSecPolicySelectedHostnames - [Configuration selected hostnames](https://techdocs.akamai.com/powershell/docs/add-appsecselectedhostnames.md): Add-AppSecSelectedHostnames - [Configuration versions](https://techdocs.akamai.com/powershell/docs/compare-appsecconfigurationversions.md): Compare-AppSecConfigurationVersions - [Policy rapid rules](https://techdocs.akamai.com/powershell/docs/disable-appsecpolicyrapidrules-1.md): Disable-AppSecPolicyRapidRules - [Policy rapid rules](https://techdocs.akamai.com/powershell/docs/enable-appsecpolicyrapidrules-1.md): Enable-AppSecPolicyRapidRules - [Configuration version](https://techdocs.akamai.com/powershell/docs/export-appsecconfiguration.md): Export-AppSecConfiguration - [Behavioral DDoS](https://techdocs.akamai.com/powershell/docs/get-appsecpolicybehavioralddos.md): Get-AppSecPolicyBehavioralDDOS - [Activation history](https://techdocs.akamai.com/powershell/docs/get-appsecactivationhistory.md): Get-AppSecActivationHistory - [Activation request status](https://techdocs.akamai.com/powershell/docs/get-appsecactivationrequeststatus.md): Get-AppSecActivationRequestStatus - [Activation status](https://techdocs.akamai.com/powershell/docs/get-appsecactivationstatus.md): Get-AppSecActivationStatus - [Attack payload](https://techdocs.akamai.com/powershell/docs/get-appsecattackpayload-1.md): Get-AppSecAttackPayload - [Available hostnames](https://techdocs.akamai.com/powershell/docs/get-appsecavailablehostnames.md): Get-AppSecAvailableHostnames - [Behavioral DDoS](https://techdocs.akamai.com/powershell/docs/get-appsecbehavioralddos-1.md) - [Configuration](https://techdocs.akamai.com/powershell/docs/get-appsecconfiguration.md): Get-AppSecConfiguration - [Configuration attack payload logging](https://techdocs.akamai.com/powershell/docs/get-appsecattackpayloadsettings.md): Get-AppSecAttackPayloadSettings - [Configuration bypass network lists](https://techdocs.akamai.com/powershell/docs/get-appsecbypassnetworklists.md): Get-AppSecBypassNetworkLists - [Configuration evaluation hostnames](https://techdocs.akamai.com/powershell/docs/get-appsecevaluationhostnames.md): Get-AppSecEvaluationHostnames - [Configuration evasive path match](https://techdocs.akamai.com/powershell/docs/get-appsecevasivepathmatch.md): Get-AppSecEvasivePathMatch - [Configuration version](https://techdocs.akamai.com/powershell/docs/get-appsecconfigurationversion.md): Get-AppSecConfigurationVersion - [Configuration version notes](https://techdocs.akamai.com/powershell/docs/get-appsecversionnotes.md): Get-AppSecVersionNotes - [Configuration HTTP header logs](https://techdocs.akamai.com/powershell/docs/get-appseclogging.md): Get-AppSecLogging - [Configuration Pragma settings](https://techdocs.akamai.com/powershell/docs/get-appsecpragmasettings.md): Get-AppSecPragmaSettings - [Configuration request body settings](https://techdocs.akamai.com/powershell/docs/get-appsecrequestsizelimit.md): Get-AppSecRequestSizeLimit - [Configuration selected hostnames](https://techdocs.akamai.com/powershell/docs/get-appsecselectedhostnames.md): Get-AppSecSelectedHostnames - [Contracts & groups](https://techdocs.akamai.com/powershell/docs/get-appseccontractsandgroups.md): Get-AppSecContractsAndGroups - [Cookie settings](https://techdocs.akamai.com/powershell/docs/get-appseccookiesettings-1.md): Get-AppSecCookieSettings - [Custom deny action](https://techdocs.akamai.com/powershell/docs/get-appseccustomdenyaction.md): Get-AppSecCustomDenyAction - [Custom rule](https://techdocs.akamai.com/powershell/docs/get-appseccustomrule.md): Get-AppSecCustomRule - [Custom rule actions](https://techdocs.akamai.com/powershell/docs/get-appsecpolicycustomrules.md): Get-AppSecPolicyCustomRules - [Custom rule usage](https://techdocs.akamai.com/powershell/docs/get-appseccustomruleusage-1.md): Get-AppSecCustomRuleUsage - [CVE](https://techdocs.akamai.com/powershell/docs/get-appseccve-1.md): Get-AppSecCVE - [CVE coverage](https://techdocs.akamai.com/powershell/docs/get-appseccvecoverage-1.md): Get-AppSecCVECoverage - [CVE subscription](https://techdocs.akamai.com/powershell/docs/get-appseccvesubscription-1.md): Get-AppSecCVESubscription - [Discovered API](https://techdocs.akamai.com/powershell/docs/get-appsecdiscoveredapi.md): Get-AppSecDiscoveredAPI - [Discovered API endpoints](https://techdocs.akamai.com/powershell/docs/get-appsecdiscoveredapiendpoints.md): Get-AppSecDiscoveredAPIEndpoints - [Export](https://techdocs.akamai.com/powershell/docs/get-appsecexport-1.md): Get-AppSecExport - [Export status](https://techdocs.akamai.com/powershell/docs/get-appsecexportstatus-1.md): Get-AppSecExportStatus - [Failover hostnames](https://techdocs.akamai.com/powershell/docs/get-appsecfailoverhostnames.md): Get-AppSecFailoverHostnames - [Hostname coverage](https://techdocs.akamai.com/powershell/docs/get-appsechostnamecoverage.md): Get-AppSecHostnameCoverage - [Hostname coverage match targets](https://techdocs.akamai.com/powershell/docs/get-appsechostnamematchtargets.md): Get-AppSecHostnameMatchTargets - [Hostname overlaps](https://techdocs.akamai.com/powershell/docs/get-appsechostnameoverlap.md): Get-AppSecHostnameOverlap - [Malware policy](https://techdocs.akamai.com/powershell/docs/get-appsecmalwarepolicy.md): Get-AppSecMalwarePolicy - [Malware policy actions](https://techdocs.akamai.com/powershell/docs/get-appsecpolicymalwarepolicy.md): Get-AppSecPolicyMalwarePolicy - [Malware policy content type](https://techdocs.akamai.com/powershell/docs/get-appsecmalwarepolicycontenttype.md): Get-AppSecMalwarePolicyContentType - [Match target](https://techdocs.akamai.com/powershell/docs/get-appsecmatchtarget.md): Get-AppSecMatchTarget - [Onboarding](https://techdocs.akamai.com/powershell/docs/get-appseconboarding.md): Get-AppSecOnboarding - [Onboarding activation](https://techdocs.akamai.com/powershell/docs/get-appseconboardingactivation-1.md): Get-AppSecOnboardingActivation - [Onboarding certificate validation](https://techdocs.akamai.com/powershell/docs/get-appseconboardingcertificatevalidation-1.md): Get-AppSecOnboardingCertificateValidation - [Onboarding CNAME record](https://techdocs.akamai.com/powershell/docs/get-appseconboardingcnamerecord.md): Get-AppSecOnboardingCNAMERecord - [Onboarding origin validation](https://techdocs.akamai.com/powershell/docs/get-appseconboardingoriginvalidation.md): Get-AppSecOnboardingOriginValidation - [Onboarding settings](https://techdocs.akamai.com/powershell/docs/get-appseconboardingsettings.md): Get-AppSecOnboardingSettings - [PII learning](https://techdocs.akamai.com/powershell/docs/get-appsecpiisettings.md): Get-AppSecPIISettings - [Policy](https://techdocs.akamai.com/powershell/docs/get-appsecpolicy.md): Get-AppSecPolicy - [Policy adaptive intelligence](https://techdocs.akamai.com/powershell/docs/get-appsecpolicyadaptiveintelligence.md): Get-AppSecPolicyAdaptiveIntelligence - [Policy API request constraints](https://techdocs.akamai.com/powershell/docs/get-appsecpolicyapirequestconstraints.md): Get-AppSecPolicyAPIRequestConstraints - [Policy API endpoints](https://techdocs.akamai.com/powershell/docs/get-appsecpolicyapiendpoints.md): Get-AppSecPolicyAPIEndpoints - [Policy attack group action](https://techdocs.akamai.com/powershell/docs/get-appsecpolicyattackgroup.md): Get-AppSecPolicyAttackGroup - [Policy attack group exceptions](https://techdocs.akamai.com/powershell/docs/get-appsecpolicyattackgroupexceptions.md): Get-AppSecPolicyAttackGroupExceptions - [Policy attack group tuning recommendations](https://techdocs.akamai.com/powershell/docs/get-appsecpolicyattackgrouprecommendations.md): Get-AppSecPolicyAttackGroupRecommendations - [Policy attack payload logging](https://techdocs.akamai.com/powershell/docs/get-appsecpolicyattackpayload.md): Get-AppSecPolicyAttackPayload - [Policy bypass network lists](https://techdocs.akamai.com/powershell/docs/get-appsecpolicybypassnetworklists.md): Get-AppSecPolicyBypassNetworkLists - [Policy CPC](https://techdocs.akamai.com/powershell/docs/get-appsecpolicycpc.md): Get-AppSecPolicyCPC - [Policy custom rule](https://techdocs.akamai.com/powershell/docs/get-appsecpolicycustomrule.md): Get-AppSecPolicyCustomRule - [Policy evaluation attack group action](https://techdocs.akamai.com/powershell/docs/get-appsecpolicyevaluationattackgroup.md): Get-AppSecPolicyEvaluationAttackGroup - [Policy evaluation attack group exceptions](https://techdocs.akamai.com/powershell/docs/get-appsecpolicyevaluationattackgroupexceptions.md): Get-AppSecPolicyEvaluationAttackGroupExceptions - [Policy evaluation hostnames](https://techdocs.akamai.com/powershell/docs/get-appsecpolicyevaluationhostnames.md): Get-AppSecPolicyEvaluationHostnames - [Policy evaluation penalty box](https://techdocs.akamai.com/powershell/docs/get-appsecpolicyevaluationpenaltybox.md): Get-AppSecPolicyEvaluationPenaltyBox - [Policy evaluation penalty box condition](https://techdocs.akamai.com/powershell/docs/get-appsecpolicyevaluationpenaltyboxcondition.md): Get-AppSecPolicyEvaluationPenaltyBoxCondition - [Policy evaluation rule action](https://techdocs.akamai.com/powershell/docs/get-appsecpolicyevaluationrule.md): Get-AppSecPolicyEvaluationRule - [Policy evaluation rule exceptions](https://techdocs.akamai.com/powershell/docs/get-appsecpolicyevaluationruleexceptions.md): Get-AppSecPolicyEvaluationRuleExceptions - [Policy evasive path match](https://techdocs.akamai.com/powershell/docs/get-appsecpolicyevasivepathmatch.md): Get-AppSecPolicyEvasivePathMatch - [Policy IP/Geo Firewall settings](https://techdocs.akamai.com/powershell/docs/get-appsecpolicyipgeofirewall.md): Get-AppSecPolicyIPGeoFirewall - [Policy HTTP header logs](https://techdocs.akamai.com/powershell/docs/get-appsecpolicylogging.md): Get-AppSecPolicyLogging - [Policy mode](https://techdocs.akamai.com/powershell/docs/get-appsecpolicymode.md): Get-AppSecPolicyMode - [Policy penalty box](https://techdocs.akamai.com/powershell/docs/get-appsecpolicypenaltybox.md): Get-AppSecPolicyPenaltyBox - [Policy Pragma settings](https://techdocs.akamai.com/powershell/docs/get-appsecpolicypragmasettings.md): Get-AppSecPolicyPragmaSettings - [Policy protections](https://techdocs.akamai.com/powershell/docs/get-appsecpolicyprotections.md): Get-AppSecPolicyProtections - [Policy rapid rule](https://techdocs.akamai.com/powershell/docs/get-appsecpolicyrapidrule.md): Get-AppSecPolicyRapidRule - [Policy rapid rule condition](https://techdocs.akamai.com/powershell/docs/get-appsecpolicyrapidrulecondition.md): Get-AppSecPolicyRapidRuleCondition - [Policy rapid rule default action](https://techdocs.akamai.com/powershell/docs/get-appsecpolicyrapidruledefaultaction.md): Get-AppSecPolicyRapidRuleDefaultAction - [Policy rapid rule lock](https://techdocs.akamai.com/powershell/docs/get-appsecpolicyrapidrulelock.md): Get-AppSecPolicyRapidRuleLock - [Policy rapid rules status](https://techdocs.akamai.com/powershell/docs/get-appsecpolicyrapidrulesstatus.md): Get-AppSecPolicyRapidRulesStatus - [Policy request body settings](https://techdocs.akamai.com/powershell/docs/get-appsecpolicyrequestsizelimit.md): Get-AppSecPolicyRequestSizeLimit - [Policy selected hostnames](https://techdocs.akamai.com/powershell/docs/get-appsecpolicyselectedhostnames.md): Get-AppSecPolicySelectedHostnames - [Policy tuning recommendations](https://techdocs.akamai.com/powershell/docs/get-appsecpolicytuningrecommendations.md): Get-AppSecPolicyTuningRecommendations - [Prefetch requests](https://techdocs.akamai.com/powershell/docs/get-appsecprefetch.md): Get-AppSecPrefetch - [Rate policy](https://techdocs.akamai.com/powershell/docs/get-appsecratepolicy.md): Get-AppSecRatePolicy - [Rate policy actions](https://techdocs.akamai.com/powershell/docs/get-appsecpolicyratepolicy.md): Get-AppSecPolicyRatePolicy - [Reputation analysis](https://techdocs.akamai.com/powershell/docs/get-appsecpolicyreputationanalysis.md): Get-AppSecPolicyReputationAnalysis - [Reputation profile](https://techdocs.akamai.com/powershell/docs/get-appsecreputationprofile.md): Get-AppSecReputationProfile - [Reputation profile action](https://techdocs.akamai.com/powershell/docs/get-appsecpolicyreputationprofile.md): Get-AppSecPolicyReputationProfile - [URL protection policy](https://techdocs.akamai.com/powershell/docs/get-appsecurlprotectionpolicy.md): Get-AppSecURLProtectionPolicy - [URL protection policy actions](https://techdocs.akamai.com/powershell/docs/get-appsecpolicyurlprotectionpolicy.md): Get-AppSecPolicyURLProtectionPolicy - [Selectable hostnames](https://techdocs.akamai.com/powershell/docs/get-appsecselectablehostnames.md): Get-AppSecSelectableHostnames - [SIEM settings](https://techdocs.akamai.com/powershell/docs/get-appsecsiemsettings.md): Get-AppSecSiemSettings - [SIEM versions](https://techdocs.akamai.com/powershell/docs/get-appsecsiemversions.md): Get-AppSecSiemVersions - [Slow POST protection](https://techdocs.akamai.com/powershell/docs/get-appsecpolicyslowpost.md): Get-AppSecPolicySlowPost - [Subscribers](https://techdocs.akamai.com/powershell/docs/get-appsecsubscribers.md): Get-AppSecSubscribers - [WAF rule action](https://techdocs.akamai.com/powershell/docs/get-appsecpolicyrule.md): Get-AppSecPolicyRule - [WAF rule exceptions](https://techdocs.akamai.com/powershell/docs/get-appsecpolicyruleexceptions.md): Get-AppSecPolicyRuleExceptions - [WAF rule tuning recommendations](https://techdocs.akamai.com/powershell/docs/get-appsecpolicyrulerecommendations.md): Get-AppSecPolicyRuleRecommendations - [WAF rule upgrade details](https://techdocs.akamai.com/powershell/docs/get-appsecpolicyupgradedetails.md): Get-AppSecPolicyUpgradeDetails - [Discovered API](https://techdocs.akamai.com/powershell/docs/hide-appsecdiscoveredapi.md): Hide-AppSecDiscoveredAPI - [Policy rapid rule](https://techdocs.akamai.com/powershell/docs/lock-appsecpolicyrapidrule.md): Lock-AppSecPolicyRapidRule - [Behavioral DDoS](https://techdocs.akamai.com/powershell/docs/new-appsecbehavioralddos.md): New-AppSecBehavioralDDOS - [Activations](https://techdocs.akamai.com/powershell/docs/new-appsecactivation.md): New-AppSecActivation - [Configuration](https://techdocs.akamai.com/powershell/docs/new-appsecconfiguration.md): New-AppSecConfiguration - [Configuration version](https://techdocs.akamai.com/powershell/docs/new-appsecconfigurationversion.md): New-AppSecConfigurationVersion - [Custom deny action](https://techdocs.akamai.com/powershell/docs/new-appseccustomdenyaction.md): New-AppSecCustomDenyAction - [Custom rule](https://techdocs.akamai.com/powershell/docs/new-appseccustomrule.md): New-AppSecCustomRule - [CVE subscription](https://techdocs.akamai.com/powershell/docs/new-appseccvesubscription.md): New-AppSecCVESubscription - [Discovered API endpoint](https://techdocs.akamai.com/powershell/docs/new-appsecdiscoveredapiendpoint.md): New-AppSecDiscoveredAPIEndpoint - [Malware policy](https://techdocs.akamai.com/powershell/docs/new-appsecmalwarepolicy.md): New-AppSecMalwarePolicy - [Match target](https://techdocs.akamai.com/powershell/docs/new-appsecmatchtarget.md): New-AppSecMatchTarget - [Onboarding](https://techdocs.akamai.com/powershell/docs/new-appseconboarding.md): New-AppSecOnboarding - [Onboarding activation](https://techdocs.akamai.com/powershell/docs/new-appseconboardingactivation.md): New-AppSecOnboardingActivation - [Policy](https://techdocs.akamai.com/powershell/docs/new-appsecpolicy.md): New-AppSecPolicy - [Rate policy](https://techdocs.akamai.com/powershell/docs/new-appsecratepolicy.md): New-AppSecRatePolicy - [Reputation profile](https://techdocs.akamai.com/powershell/docs/new-appsecreputationprofile.md): New-AppSecReputationProfile - [Subscriptions](https://techdocs.akamai.com/powershell/docs/new-appsecsubscription.md): New-AppSecSubscription - [URL protection policy](https://techdocs.akamai.com/powershell/docs/new-appsecurlprotectionpolicy.md): New-AppSecURLProtectionPolicy - [Configuration evaluation hostnames](https://techdocs.akamai.com/powershell/docs/protect-appsecevaluationhostnames.md): Protect-AppSecEvaluationHostnames - [Policy evaluation hostnames](https://techdocs.akamai.com/powershell/docs/protect-appsecpolicyevaluationhostnames.md): Protect-AppSecPolicyEvaluationHostnames - [Behavioral DDoS](https://techdocs.akamai.com/powershell/docs/remove-appsecbehavioralddos.md): Remove-AppSecBehavioralDDOS - [Configuration](https://techdocs.akamai.com/powershell/docs/remove-appsecconfiguration.md): Remove-AppSecConfiguration - [Configuration version](https://techdocs.akamai.com/powershell/docs/remove-appsecconfigurationversion.md): Remove-AppSecConfigurationVersion - [Configuration selected hostnames](https://techdocs.akamai.com/powershell/docs/remove-appsecselectedhostnames.md): Remove-AppSecSelectedHostnames - [Custom deny action](https://techdocs.akamai.com/powershell/docs/remove-appseccustomdenyaction.md): Remove-AppSecCustomDenyAction - [Custom rule](https://techdocs.akamai.com/powershell/docs/remove-appseccustomrule.md): Remove-AppSecCustomRule - [CVE subscription](https://techdocs.akamai.com/powershell/docs/remove-appseccvesubscription.md): Remove-AppSecCVESubscription - [Malware policy](https://techdocs.akamai.com/powershell/docs/remove-appsecmalwarepolicy.md): Remove-AppSecMalwarePolicy - [Match target](https://techdocs.akamai.com/powershell/docs/remove-appsecmatchtarget.md): Remove-AppSecMatchTarget - [Onboarding](https://techdocs.akamai.com/powershell/docs/remove-appseconboarding.md): Remove-AppSecOnboarding - [Policy](https://techdocs.akamai.com/powershell/docs/remove-appsecpolicy.md): Remove-AppSecPolicy - [Policy selected hostnames](https://techdocs.akamai.com/powershell/docs/remove-appsecpolicyselectedhostnames.md): Remove-AppSecPolicySelectedHostnames - [Rate policy](https://techdocs.akamai.com/powershell/docs/remove-appsecratepolicy.md): Remove-AppSecRatePolicy - [Reputation profile](https://techdocs.akamai.com/powershell/docs/remove-appsecreputationprofile.md): Remove-AppSecReputationProfile - [Subscriptions](https://techdocs.akamai.com/powershell/docs/remove-appsecsubscription.md): Remove-AppSecSubscription - [URL protection policy](https://techdocs.akamai.com/powershell/docs/remove-appsecurlprotectionpolicy.md): Remove-AppSecURLProtectionPolicy - [Configuration](https://techdocs.akamai.com/powershell/docs/rename-appsecconfiguration.md): Rename-AppSecConfiguration - [Attack payload](https://techdocs.akamai.com/powershell/docs/set-appsecattackpayload.md): Set-AppSecAttackPayload - [Behavioral DDoS](https://techdocs.akamai.com/powershell/docs/set-appsecbehavioralddos.md): Set-AppSecBehavioralDDOS - [Configuration attack payload logging](https://techdocs.akamai.com/powershell/docs/set-appsecattackpayloadsettings.md): Set-AppSecAttackPayloadSettings - [Configuration bypass network lists](https://techdocs.akamai.com/powershell/docs/set-appsecbypassnetworklists.md): Set-AppSecBypassNetworkLists - [Configuration evaluation hostnames](https://techdocs.akamai.com/powershell/docs/set-appsecevaluationhostnames.md): Set-AppSecEvaluationHostnames - [Configuration evasive path match](https://techdocs.akamai.com/powershell/docs/set-appsecevasivepathmatch.md): Set-AppSecEvasivePathMatch - [Configuration HTTP header logs](https://techdocs.akamai.com/powershell/docs/set-appseclogging.md): Set-AppSecLogging - [Configuration Pragma settings](https://techdocs.akamai.com/powershell/docs/set-appsecpragmasettings.md): Set-AppSecPragmaSettings - [Configuration selected hostnames](https://techdocs.akamai.com/powershell/docs/set-appsecselectedhostnames.md): Set-AppSecSelectedHostnames - [Configuration request body settings](https://techdocs.akamai.com/powershell/docs/set-appsecrequestsizelimit.md): Set-AppSecRequestSizeLimit - [Configuration version notes](https://techdocs.akamai.com/powershell/docs/set-appsecversionnotes.md): Set-AppSecVersionNotes - [Cookie settings](https://techdocs.akamai.com/powershell/docs/set-appseccookiesettings.md): Set-AppSecCookieSettings - [Custom deny action](https://techdocs.akamai.com/powershell/docs/set-appseccustomdenyaction.md): Set-AppSecCustomDenyAction - [Custom rule](https://techdocs.akamai.com/powershell/docs/set-appseccustomrule.md): Set-AppSecCustomRule - [Evaluation rate policy](https://techdocs.akamai.com/powershell/docs/set-appsecevaluationratepolicy.md): Set-AppSecEvaluationRatePolicy - [JA4 fingerprint](https://techdocs.akamai.com/powershell/docs/set-appsecja4fingerprint.md): Set-AppSecJA4Fingerprint - [Malware policy](https://techdocs.akamai.com/powershell/docs/set-appsecmalwarepolicy.md): Set-AppSecMalwarePolicy - [Match target](https://techdocs.akamai.com/powershell/docs/set-appsecmatchtarget.md): Set-AppSecMatchTarget - [Match target order](https://techdocs.akamai.com/powershell/docs/set-appsecmatchtargetorder.md): Set-AppSecMatchTargetOrder - [PII learning](https://techdocs.akamai.com/powershell/docs/set-appsecpiisettings.md): Set-AppSecPIISettings - [Onboarding origin validation](https://techdocs.akamai.com/powershell/docs/submit-appseconboardingoriginvalidation.md): Submit-AppSecOnboardingOriginValidation - [Onboarding settings](https://techdocs.akamai.com/powershell/docs/set-appseconboardingsettings.md): Set-AppSecOnboardingSettings - [Policy](https://techdocs.akamai.com/powershell/docs/set-appsecpolicy.md): Set-AppSecPolicy - [Policy adaptive intelligence](https://techdocs.akamai.com/powershell/docs/set-appsecpolicyadaptiveintelligence.md): Set-AppSecPolicyAdaptiveIntelligence - [Policy API request constraints](https://techdocs.akamai.com/powershell/docs/set-appsecpolicyapirequestconstraints.md): Set-AppSecPolicyAPIRequestConstraints - [Policy attack group action](https://techdocs.akamai.com/powershell/docs/set-appsecpolicyattackgroup.md): Set-AppSecPolicyAttackGroup - [Policy attack group exceptions](https://techdocs.akamai.com/powershell/docs/set-appsecpolicyattackgroupexceptions.md): Set-AppSecPolicyAttackGroupExceptions - [Policy attack payload logging](https://techdocs.akamai.com/powershell/docs/set-appsecpolicyattackpayload.md): Set-AppSecPolicyAttackPayload - [Policy behavioral DDoS](https://techdocs.akamai.com/powershell/docs/set-appsecpolicybehavioralddos.md): Set-AppSecPolicyBehavioralDDOS - [Policy bypass network lists](https://techdocs.akamai.com/powershell/docs/set-appsecpolicybypassnetworklists.md): Set-AppSecPolicyBypassNetworkLists - [Policy CPC](https://techdocs.akamai.com/powershell/docs/set-appsecpolicycpc.md): Set-AppSecPolicyCPC - [Policy custom rule action](https://techdocs.akamai.com/powershell/docs/set-appsecpolicycustomrule.md): Set-AppSecPolicyCustomRule - [Policy evaluation attack group action](https://techdocs.akamai.com/powershell/docs/set-appsecpolicyevaluationattackgroup.md): Set-AppSecPolicyEvaluationAttackGroup - [Policy evaluation attack group exceptions](https://techdocs.akamai.com/powershell/docs/set-appsecpolicyevaluationattackgroupexceptions.md): Set-AppSecPolicyEvaluationAttackGroupExceptions - [Policy evaluation hostnames](https://techdocs.akamai.com/powershell/docs/set-appsecpolicyevaluationhostnames.md): Set-AppSecPolicyEvaluationHostnames - [Policy evaluation mode](https://techdocs.akamai.com/powershell/docs/set-appsecpolicyevaluationmode.md): Set-AppSecPolicyEvaluationMode - [Policy evaluation penalty box](https://techdocs.akamai.com/powershell/docs/set-appsecpolicyevaluationpenaltybox.md): Set-AppSecPolicyEvaluationPenaltyBox - [Policy evaluation penalty box condition](https://techdocs.akamai.com/powershell/docs/set-appsecpolicyevaluationpenaltyboxcondition.md): Set-AppSecPolicyEvaluationPenaltyBoxCondition - [Policy evaluation rule action](https://techdocs.akamai.com/powershell/docs/set-appsecpolicyevaluationrule.md): Set-AppSecPolicyEvaluationRule - [Policy evaluation rule exceptions](https://techdocs.akamai.com/powershell/docs/set-appsecpolicyevaluationruleexceptions.md): Set-AppSecPolicyEvaluationRuleExceptions - [Policy evasive path match](https://techdocs.akamai.com/powershell/docs/set-appsecpolicyevasivepathmatch.md): Set-AppSecPolicyEvasivePathMatch - [Policy IP/Geo Firewall settings](https://techdocs.akamai.com/powershell/docs/set-appsecpolicyipgeofirewall.md): Set-AppSecPolicyIPGeoFirewall - [Policy HTTP header logs](https://techdocs.akamai.com/powershell/docs/set-appsecpolicylogging.md): Set-AppSecPolicyLogging - [Policy malware policy action](https://techdocs.akamai.com/powershell/docs/set-appsecpolicymalwarepolicy.md): Set-AppSecPolicyMalwarePolicy - [Policy mode](https://techdocs.akamai.com/powershell/docs/set-appsecpolicymode.md): Set-AppSecPolicyMode - [Policy penalty box](https://techdocs.akamai.com/powershell/docs/set-appsecpolicypenaltybox.md): Set-AppSecPolicyPenaltyBox - [Policy penalty box condition](https://techdocs.akamai.com/powershell/docs/set-appsecpolicypenaltyboxcondition.md): Set-AppSecPolicyPenaltyBoxCondition - [Policy Pragma settings](https://techdocs.akamai.com/powershell/docs/set-appsecpolicypragmasettings.md): Set-AppSecPolicyPragmaSettings - [Policy protections](https://techdocs.akamai.com/powershell/docs/set-appsecpolicyprotections.md): Set-AppSecPolicyProtections - [Policy rapid rule](https://techdocs.akamai.com/powershell/docs/set-appsecpolicyrapidrule.md): Set-AppSecPolicyRapidRule - [Policy rapid rule condition](https://techdocs.akamai.com/powershell/docs/set-appsecpolicyrapidrulecondition.md): Set-AppSecPolicyRapidRuleCondition - [Policy rapid rule default action](https://techdocs.akamai.com/powershell/docs/set-appsecpolicyrapidruledefaultaction.md): Set-AppSecPolicyRapidRuleDefaultAction - [Policy rate policy actions](https://techdocs.akamai.com/powershell/docs/set-appsecpolicyratepolicy.md): Set-AppSecPolicyRatePolicy - [Policy reputation profile action](https://techdocs.akamai.com/powershell/docs/set-appsecpolicyreputationprofile.md): Set-AppSecPolicyReputationProfile - [Policy request body settings](https://techdocs.akamai.com/powershell/docs/set-appsecpolicyrequestsizelimit.md): Set-AppSecPolicyRequestSizeLimit - [Policy selected hostnames](https://techdocs.akamai.com/powershell/docs/set-appsecpolicyselectedhostnames.md): Set-AppSecPolicySelectedHostnames - [Policy tuning recommendations](https://techdocs.akamai.com/powershell/docs/set-appsecpolicytuningrecommendations.md): Set-AppSecPolicyTuningRecommendations - [Prefetch requests](https://techdocs.akamai.com/powershell/docs/set-appsecprefetch.md): Set-AppSecPrefetch - [Rate policy](https://techdocs.akamai.com/powershell/docs/set-appsecratepolicy.md): Set-AppSecRatePolicy - [Reputation analysis](https://techdocs.akamai.com/powershell/docs/set-appsecpolicyreputationanalysis.md): Set-AppSecPolicyReputationAnalysis - [Reputation profile](https://techdocs.akamai.com/powershell/docs/set-appsecreputationprofile.md): Set-AppSecReputationProfile - [SIEM settings](https://techdocs.akamai.com/powershell/docs/set-appsecsiemsettings.md): Set-AppSecSiemSettings - [Slow POST protection](https://techdocs.akamai.com/powershell/docs/set-appsecpolicyslowpost.md): Set-AppSecPolicySlowPost - [WAF policy rule action](https://techdocs.akamai.com/powershell/docs/set-appsecpolicyrule.md): Set-AppSecPolicyRule - [WAF rule exceptions](https://techdocs.akamai.com/powershell/docs/set-appsecpolicyruleexceptions.md): Set-AppSecPolicyRuleExceptions - [URL protection policy](https://techdocs.akamai.com/powershell/docs/set-appsecurlprotectionpolicy.md): Set-AppSecURLProtectionPolicy - [URL protection policy actions](https://techdocs.akamai.com/powershell/docs/set-appsecpolicyurlprotectionpolicy.md): Set-AppSecPolicyURLProtectionPolicy - [Discovered API](https://techdocs.akamai.com/powershell/docs/show-appsecdiscoveredapi.md): Show-AppSecDiscoveredAPI - [Onboarding origin validation](https://techdocs.akamai.com/powershell/docs/skip-appseconboardingoriginvalidation.md): Skip-AppSecOnboardingOriginValidation - [Onboarding CNAME record](https://techdocs.akamai.com/powershell/docs/submit-appseconboardingcnamerecord.md): Submit-AppSecOnboardingCNAMERecord - [Onboarding certificate validation](https://techdocs.akamai.com/powershell/docs/submit-appseconboardingcertificatevalidation.md): Submit-AppSecOnboardingCertificateValidation - [Policy rapid rule](https://techdocs.akamai.com/powershell/docs/unlock-appsecpolicyrapidrule.md): Unlock-AppSecPolicyRapidRule - [KRS rule set](https://techdocs.akamai.com/powershell/docs/update-appseckrsruleset.md): Update-AppSecKRSRuleSet - [Function index](https://techdocs.akamai.com/powershell/docs/china-cdn-index.md) - [Deprovision policy](https://techdocs.akamai.com/powershell/docs/get-chinacdndeprovisionpolicy.md): Get-ChinaCDNDeprovisionPolicy - [Edge hostnames](https://techdocs.akamai.com/powershell/docs/get-chinacdnedgehostnames.md): Get-ChinaCDNEdgeHostnames - [Groups](https://techdocs.akamai.com/powershell/docs/get-chinacdngroups.md): Get-ChinaCDNGroups - [ICP holding entities](https://techdocs.akamai.com/powershell/docs/get-chinacdnholdingentities.md): Get-ChinaCDNHoldingEntities - [ICP numbers](https://techdocs.akamai.com/powershell/docs/get-chinacdnicpnumbers.md): Get-ChinaCDNICPNumbers - [Property hostname](https://techdocs.akamai.com/powershell/docs/get-chinacdnpropertyhostname.md): Get-ChinaCDNPropertyHostname - [Provision state change](https://techdocs.akamai.com/powershell/docs/get-chinacdnprovisionstatechange.md): Get-ChinaCDNProvisionStateChange - [Provision states](https://techdocs.akamai.com/powershell/docs/get-chinacdnprovisionstates.md): Get-ChinaCDNProvisionStates - [Property hostname](https://techdocs.akamai.com/powershell/docs/new-chinacdnpropertyhostname.md): New-ChinaCDNPropertyHostname - [Provision state change](https://techdocs.akamai.com/powershell/docs/new-chinacdnprovisionstatechange.md): New-ChinaCDNProvisionStateChange - [Deprovision policy](https://techdocs.akamai.com/powershell/docs/set-chinacdndeprovisionpolicy.md): Set-ChinaCDNDeprovisionPolicy - [Provision certificates](https://techdocs.akamai.com/powershell/docs/provision-certificates.md) - [Function index](https://techdocs.akamai.com/powershell/docs/cps-index.md) - [3-party certificate](https://techdocs.akamai.com/powershell/docs/add-cpsthirdpartycert.md): Add-CPSThirdPartyCert - [Change](https://techdocs.akamai.com/powershell/docs/complete-cpschange.md): Complete-CPSChange - [Let's Encrypt challenges](https://techdocs.akamai.com/powershell/docs/confirm-cpsletsencryptchallengescompleted.md): Confirm-CPSLetsEncryptChallengesCompleted - [Post-verification warnings](https://techdocs.akamai.com/powershell/docs/confirm-cpspostverificationwarnings.md): Confirm-CPSPostVerificationWarnings - [Pre-verification warnings](https://techdocs.akamai.com/powershell/docs/confirm-cpspreverificationwarnings.md): Confirm-CPSPreVerificationWarnings - [Active Certificate](https://techdocs.akamai.com/powershell/docs/get-cpsactivecertificate.md): Get-CPSActiveCertificate - [Certificate history](https://techdocs.akamai.com/powershell/docs/get-cpscertificatehistory.md): Get-CPSCertificateHistory - [Certificate signing request](https://techdocs.akamai.com/powershell/docs/get-cpscsr.md): Get-CPSCSR - [Change history](https://techdocs.akamai.com/powershell/docs/get-cpschangehistory.md): Get-CPSChangeHistory - [Change status](https://techdocs.akamai.com/powershell/docs/get-cpschangestatus.md): Get-CPSChangeStatus - [Change status on staging](https://techdocs.akamai.com/powershell/docs/get-cpschangestagingstatus.md): Get-CPSChangeStagingStatus - [Deployments](https://techdocs.akamai.com/powershell/docs/get-cpsdeployment.md): Get-CPSDeployment - [Deployment schedule](https://techdocs.akamai.com/powershell/docs/get-cpsdeploymentschedule.md): Get-CPSDeploymentSchedule - [DV history](https://techdocs.akamai.com/powershell/docs/get-cpsdvhistory.md): Get-CPSDVHistory - [Enrollment](https://techdocs.akamai.com/powershell/docs/get-cpsenrollment.md): Get-CPSEnrollment - [Let's Encrypt challenges](https://techdocs.akamai.com/powershell/docs/get-cpsletsencryptchallenges.md): Get-CPSLetsEncryptChallenges - [Post-verification warnings](https://techdocs.akamai.com/powershell/docs/get-cpspostverificationwarnings.md): Get-CPSPostVerificationWarnings - [Pre-verification warnings](https://techdocs.akamai.com/powershell/docs/get-cpspreverificationwarnings.md): Get-CPSPreVerificationWarnings - [Production deployment](https://techdocs.akamai.com/powershell/docs/get-cpsproductiondeployment.md): Get-CPSProductionDeployment - [Staging deployment](https://techdocs.akamai.com/powershell/docs/get-cpsstagingdeployment.md): Get-CPSStagingDeployment - [Enrollment](https://techdocs.akamai.com/powershell/docs/new-cpsenrollment.md): New-CPSEnrollment - [Deployment schedule](https://techdocs.akamai.com/powershell/docs/set-cpsdeploymentschedule.md): Set-CPSDeploymentSchedule - [Enrollment](https://techdocs.akamai.com/powershell/docs/set-cpsenrollment.md): Set-CPSEnrollment - [Change](https://techdocs.akamai.com/powershell/docs/remove-cpschange.md): Remove-CPSChange - [Enrollment](https://techdocs.akamai.com/powershell/docs/remove-cpsenrollment.md): Remove-CPSEnrollment - [Configure client lists](https://techdocs.akamai.com/powershell/docs/configure-client-lists.md) - [Function index](https://techdocs.akamai.com/powershell/docs/cl-index.md) - [List item](https://techdocs.akamai.com/powershell/docs/add-clientlistitem.md): Add-ClientListItem - [Client list](https://techdocs.akamai.com/powershell/docs/get-clientlist.md): Get-ClientList - [Contracts & groups](https://techdocs.akamai.com/powershell/docs/get-clientlistcontractsgroups.md): Get-ClientListContractsGroups - [Activation](https://techdocs.akamai.com/powershell/docs/get-clientlistactivation.md): Get-ClientListActivation - [Activation status](https://techdocs.akamai.com/powershell/docs/get-clientlistactivationstatus.md): Get-ClientListActivationStatus - [List item](https://techdocs.akamai.com/powershell/docs/get-clientlistitem.md): Get-ClientListItem - [Snapshot](https://techdocs.akamai.com/powershell/docs/get-clientlistsnapshot.md): Get-ClientListSnapshot - [Tags](https://techdocs.akamai.com/powershell/docs/get-clientlisttag.md): Get-ClientListTag - [Usage data](https://techdocs.akamai.com/powershell/docs/get-clientlistusage.md): Get-ClientListUsage - [List item](https://techdocs.akamai.com/powershell/docs/import-clientlistitem.md) - [Activation](https://techdocs.akamai.com/powershell/docs/new-clientlistactivation.md): New-ClientListActivation - [Client list](https://techdocs.akamai.com/powershell/docs/new-clientlist.md): New-ClientList - [Deactivation](https://techdocs.akamai.com/powershell/docs/new-clientlistdeactivation.md): New-ClientListDeactivation - [Subscription](https://techdocs.akamai.com/powershell/docs/new-clientlistsubscription.md) - [Client list](https://techdocs.akamai.com/powershell/docs/remove-clientlist.md): Remove-ClientList - [Item](https://techdocs.akamai.com/powershell/docs/remove-clientlistitem.md) - [Subscription](https://techdocs.akamai.com/powershell/docs/remove-clientlistsubscription.md) - [Client list](https://techdocs.akamai.com/powershell/docs/set-clientlist.md): Set-ClientList - [List item](https://techdocs.akamai.com/powershell/docs/set-clientlistitem.md): Set-ClientListItem - [List items](https://techdocs.akamai.com/powershell/docs/test-clientlistitem.md): Test-ClientListItems - [Manage cloud origin access](https://techdocs.akamai.com/powershell/docs/manage-cloud-origin-access.md) - [Function index](https://techdocs.akamai.com/powershell/docs/cam-index.md) - [Access key](https://techdocs.akamai.com/powershell/docs/get-cloudaccesskey.md): Get-CloudAccessKey - [Access key creation status](https://techdocs.akamai.com/powershell/docs/get-cloudaccesskeycreaterequest.md): Get-CloudAccessKeyCreateRequest - [Access key version](https://techdocs.akamai.com/powershell/docs/get-cloudaccesskeyversion.md): Get-CloudAccessKeyVersion - [Access key version creation status](https://techdocs.akamai.com/powershell/docs/get-cloudaccesskeyversioncreaterequest.md): Get-CloudAccessKeyVersionCreateRequest - [Access key version properties](https://techdocs.akamai.com/powershell/docs/get-cloudaccesskeyversionproperties.md): Get-CloudAccessKeyVersionProperties - [Access key version status](https://techdocs.akamai.com/powershell/docs/get-cloudaccesskeyversionstatus.md): Get-CloudAccessKeyVersionStatus - [Property lookup](https://techdocs.akamai.com/powershell/docs/get-cloudaccesslookup.md): Get-CloudAccessLookup - [Access key](https://techdocs.akamai.com/powershell/docs/new-cloudaccesskey.md): New-CloudAccessKey - [Access key version](https://techdocs.akamai.com/powershell/docs/new-cloudaccesskeyversion.md): New-CloudAccessKeyVersion - [Property lookup](https://techdocs.akamai.com/powershell/docs/new-cloudaccesslookup.md): New-CloudAccessLookup - [Access key](https://techdocs.akamai.com/powershell/docs/remove-cloudaccesskey.md) - [Access key version](https://techdocs.akamai.com/powershell/docs/remove-cloudaccesskeyversion.md): Remove-CloudAccessKeyVersion - [Access key](https://techdocs.akamai.com/powershell/docs/rename-cloudaccesskey.md) - [Add a custom cache layer](https://techdocs.akamai.com/powershell/docs/set-up-cloud-wrapper.md) - [Function index](https://techdocs.akamai.com/powershell/docs/cw-index.md) - [Auth keys](https://techdocs.akamai.com/powershell/docs/get-cloudwrapperauthkey.md): Get-CloudWrapperAuthKey - [Capacities](https://techdocs.akamai.com/powershell/docs/get-cloudwrappercapacity.md): Get-CloudWrapperCapacity - [CDN providers](https://techdocs.akamai.com/powershell/docs/get-cloudwrapperprovider.md): Get-CloudWrapperProvider - [Configuration](https://techdocs.akamai.com/powershell/docs/get-cloudwrapperconfiguration.md): Get-CloudWrapperConfiguration - [Locations](https://techdocs.akamai.com/powershell/docs/get-cloudwrapperlocation.md): Get-CloudWrapperLocation - [Origin hostnames](https://techdocs.akamai.com/powershell/docs/get-cloudwrapperconfigurationorigins.md): Get-CloudWrapperConfigurationOrigins - [Origins](https://techdocs.akamai.com/powershell/docs/get-cloudwrapperorigin.md): Get-CloudwrapperOrigin - [Properties](https://techdocs.akamai.com/powershell/docs/get-cloudwrapperproperty.md): Get-CloudWrapperProperty - [Configuration](https://techdocs.akamai.com/powershell/docs/new-cloudwrapperconfiguration.md): New-CloudWrapperConfiguration - [Configuration activation](https://techdocs.akamai.com/powershell/docs/new-cloudwrapperconfigurationactivation.md): New-CloudWrapperConfigurationActivation - [Configuration](https://techdocs.akamai.com/powershell/docs/remove-cloudwrapperconfiguration.md): Remove-CloudWrapperConfiguration - [Configuration](https://techdocs.akamai.com/powershell/docs/set-cloudwrapperconfiguration.md): Set-CloudWrapperConfiguration - [Set up cloudlet policies](https://techdocs.akamai.com/powershell/docs/cloudlets.md) - [Policies](https://techdocs.akamai.com/powershell/docs/policies.md) - [Load balancer](https://techdocs.akamai.com/powershell/docs/load-balancer-configurations.md) - [Origin server](https://techdocs.akamai.com/powershell/docs/origin-server.md) - [Function index](https://techdocs.akamai.com/powershell/docs/cloudlets-index.md) - [Policy](https://techdocs.akamai.com/powershell/docs/copy-cloudletpolicy.md): Copy-CloudletPolicy - [Active properties](https://techdocs.akamai.com/powershell/docs/get-cloudletpolicyproperty.md): Get-CloudletPolicyProperty - [Associated properties](https://techdocs.akamai.com/powershell/docs/get-cloudletproperty.md): Get-CloudletProperty - [Cloudlet](https://techdocs.akamai.com/powershell/docs/get-cloudlet.md): Get-Cloudlet - [Group](https://techdocs.akamai.com/powershell/docs/get-cloudletgroup.md): Get-CloudletGroup - [Load balancer](https://techdocs.akamai.com/powershell/docs/get-cloudletloadbalancer.md): Get-CloudletLoadBalancer - [Load balancer activation](https://techdocs.akamai.com/powershell/docs/get-cloudletloadbalanceractivation.md): Get-CloudletLoadBalancerActivation - [Load balancer version](https://techdocs.akamai.com/powershell/docs/get-cloudletloadbalancerversion.md): Get-CloudletLoadBalancerVersion - [Policy](https://techdocs.akamai.com/powershell/docs/get-cloudletpolicy.md): Get-CloudletPolicy - [Policy activation](https://techdocs.akamai.com/powershell/docs/get-cloudletpolicyactivation.md): Get-CloudletPolicyActivation - [Policy CSV](https://techdocs.akamai.com/powershell/docs/get-cloudletpolicycsv.md): Get-CloudletPolicyCSV - [Policy version](https://techdocs.akamai.com/powershell/docs/get-cloudletpolicyversion.md): Get-CloudletPolicyVersion - [Policy version rule](https://techdocs.akamai.com/powershell/docs/get-cloudletpolicyversionrule.md): Get-CloudletPolicyVersionRule - [Schema](https://techdocs.akamai.com/powershell/docs/get-cloudletschema.md): Get-CloudletSchema - [Load balancer](https://techdocs.akamai.com/powershell/docs/new-cloudletloadbalancer.md): New-CloudletLoadBalancer - [Load balancer activation](https://techdocs.akamai.com/powershell/docs/new-cloudletloadbalanceractivation.md): New-CloudletLoadBalancerActivation - [Load balancer version](https://techdocs.akamai.com/powershell/docs/new-cloudletloadbalancerversion.md): New-CloudletLoadBalancerVersion - [Policy](https://techdocs.akamai.com/powershell/docs/new-cloudletpolicy.md): New-CloudletPolicy - [Policy version](https://techdocs.akamai.com/powershell/docs/new-cloudletpolicyversion.md): New-CloudletPolicyVersion - [Policy activation](https://techdocs.akamai.com/powershell/docs/new-cloudletpolicyactivation.md): New-CloudletPolicyActivation - [Policy version deactivation](https://techdocs.akamai.com/powershell/docs/new-cloudletpolicydeactivation.md): New-CloudletPolicyDeactivation - [Policy version rule](https://techdocs.akamai.com/powershell/docs/new-cloudletpolicyversionrule.md): New-CloudletPolicyVersionRule - [Load balancer](https://techdocs.akamai.com/powershell/docs/remove-cloudletloadbalancer.md) - [Policy](https://techdocs.akamai.com/powershell/docs/remove-cloudletpolicy.md): Remove-CloudletPolicy - [Policy version](https://techdocs.akamai.com/powershell/docs/remove-cloudletpolicyversion.md): Remove-CloudletPolicyVersion - [Load balancer](https://techdocs.akamai.com/powershell/docs/set-cloudletloadbalancer.md): Set-CloudletLoadBalancer - [Load balancer version](https://techdocs.akamai.com/powershell/docs/set-cloudletloadbalancerversion.md): Set-CloudletLoadBalancerVersion - [Policy](https://techdocs.akamai.com/powershell/docs/set-cloudletpolicy.md): Set-CloudletPolicy - [Policy version](https://techdocs.akamai.com/powershell/docs/set-cloudletpolicyversion.md): Set-CloudletPolicyVersion - [Policy version rule](https://techdocs.akamai.com/powershell/docs/set-cloudletpolicyversionrule.md): Set-CloudletPolicyVersionRule - [Function index](https://techdocs.akamai.com/powershell/docs/common-index.md) - [EdgeGrid credentials](https://techdocs.akamai.com/powershell/docs/clear-edgegridcredentials.md) - [Akamai data cache](https://techdocs.akamai.com/powershell/docs/clear-akamaidatacache.md): Clear-AkamaiDataCache - [Akamai options](https://techdocs.akamai.com/powershell/docs/clear-akamaioptions.md): Clear-AkamaiOptions - [EdgeGrid credentials](https://techdocs.akamai.com/powershell/docs/export-edgegridcredentials.md): Export-EdgegridCredentials - [Netstorage credentials](https://techdocs.akamai.com/powershell/docs/export-netstoragecredentials.md): Export-NetstorageCredentials - [Edgegrid credentials](https://techdocs.akamai.com/powershell/docs/get-edgegridcredentials.md): Get-EdgegridCredentials - [Akamai options](https://techdocs.akamai.com/powershell/docs/get-akamaioptions.md): Get-AkamaiOptions - [Auth grants](https://techdocs.akamai.com/powershell/docs/get-authgrants.md): Get-AuthGrants - [Netstorage Credentials](https://techdocs.akamai.com/powershell/docs/get-netstoragecredentials.md): Get-NetstorageCredentials - [EdgeGrid credentials](https://techdocs.akamai.com/powershell/docs/import-edgegridcredentials.md): Import-EdgegridCredentials - [Netstorage credentials](https://techdocs.akamai.com/powershell/docs/import-netstoragecredentials.md): Import-NetstorageCredentials - [Akamai NSAPI request](https://techdocs.akamai.com/powershell/docs/invoke-akamainsapirequest.md): Invoke-AkamaiNSAPIRequest - [Akamai REST method](https://techdocs.akamai.com/powershell/docs/invoke-akamairestmethod.md): Invoke-AkamaiRestMethod - [Netstorage request](https://techdocs.akamai.com/powershell/docs/invoke-netstoragerequest.md) - [Akamai request](https://techdocs.akamai.com/powershell/docs/invoke-akamairequest.md): Invoke-AkamaiRequest - [Akamai data cache](https://techdocs.akamai.com/powershell/docs/new-akamaidatacache.md): New-AkamaiDataCache - [Akamai options](https://techdocs.akamai.com/powershell/docs/new-akamaioptions.md): New-AkamaiOptions - [EdgeGrid auth token](https://techdocs.akamai.com/powershell/docs/new-edgeauthtoken.md): New-EdgeAuthToken - [Akamai data cache](https://techdocs.akamai.com/powershell/docs/set-akamaidatacache.md): Set-AkamaiDataCache - [Akamai options](https://techdocs.akamai.com/powershell/docs/set-akamaioptions.md): Set-AkamaiOptions - [EdgeGrid credentials](https://techdocs.akamai.com/powershell/docs/test-edgegridcredentials.md): Test-EdgegridCredentials - [OpenAPI](https://techdocs.akamai.com/powershell/docs/test-openapi.md): Test-OpenAPI - [View contracts and related products](https://techdocs.akamai.com/powershell/docs/contracts.md) - [Function index](https://techdocs.akamai.com/powershell/docs/contracts-index.md) - [Contracts](https://techdocs.akamai.com/powershell/docs/get-contract.md): Get-Contract - [Products per contract](https://techdocs.akamai.com/powershell/docs/get-productspercontract.md): Get-ProductsPerContract - [Products per reporting group](https://techdocs.akamai.com/powershell/docs/get-productsperreportinggroup.md): Get-ProductsPerReportingGroup - [Reporting group](https://techdocs.akamai.com/powershell/docs/get-contractreportinggroup.md) - [Reporting group identifier](https://techdocs.akamai.com/powershell/docs/get-contractreportinggroupidentifier.md) - [Manage site traffic](https://techdocs.akamai.com/powershell/docs/cp-codes.md) - [Function index](https://techdocs.akamai.com/powershell/docs/cp-codes-index.md) - [CP code](https://techdocs.akamai.com/powershell/docs/get-cpcode.md): Get-CPCode - [Products](https://techdocs.akamai.com/powershell/docs/get-cpreportinggroupproducts.md): Get-CPReportingGroupProducts - [Reporting group](https://techdocs.akamai.com/powershell/docs/get-cpreportinggroup.md): Get-CPReportingGroup - [Watermark limit for CP codes](https://techdocs.akamai.com/powershell/docs/get-cpcodewatermarklimit.md): Get-CPCodeWatermarkLimit - [Watermark limit for reporting groups](https://techdocs.akamai.com/powershell/docs/get-cpreportinggroupwatermarklimit.md): Get-CPReportingGroupWatermarkLimit - [Reporting group](https://techdocs.akamai.com/powershell/docs/new-cpreportinggroup.md): New-CPReportingGroup - [Reporting group](https://techdocs.akamai.com/powershell/docs/remove-cpreportinggroup.md): Remove-CPReportingGroup - [CP code](https://techdocs.akamai.com/powershell/docs/set-cpcode.md): Set-CPCode - [Reporting group](https://techdocs.akamai.com/powershell/docs/set-cpreportinggroup.md): Set-CPReportingGroup - [Create data streams](https://techdocs.akamai.com/powershell/docs/datastream.md) - [Data sets](https://techdocs.akamai.com/powershell/docs/data-sets.md) - [Destinations](https://techdocs.akamai.com/powershell/docs/destinations.md) - [Function index](https://techdocs.akamai.com/powershell/docs/ds-index.md) - [Activation history](https://techdocs.akamai.com/powershell/docs/get-datastreamactivationhistory.md): Get-DataStreamActivationHistory - [Data set fields](https://techdocs.akamai.com/powershell/docs/get-datastreamdatasets.md): Get-DatastreamDatasets - [Data stream](https://techdocs.akamai.com/powershell/docs/get-datastream.md): Get-DataStream - [EDNS zones](https://techdocs.akamai.com/powershell/docs/get-datastreamednszones.md): Get-DatastreamEDNSZones - [Groups](https://techdocs.akamai.com/powershell/docs/get-datastreamgroups.md): Get-DatastreamGroups - [GTM properties](https://techdocs.akamai.com/powershell/docs/get-datastreamgtmproperties.md): Get-DatastreamGTMProperties - [History](https://techdocs.akamai.com/powershell/docs/get-datastreamhistory.md): Get-DataStreamHistory - [Properties](https://techdocs.akamai.com/powershell/docs/get-datastreamproperties.md): Get-DatastreamProperties - [Upload metrics](https://techdocs.akamai.com/powershell/docs/get-datastreammetrics.md): Get-DataStreamMetrics - [Activation](https://techdocs.akamai.com/powershell/docs/new-datastreamactivation.md): New-DataStreamActivation - [Data stream](https://techdocs.akamai.com/powershell/docs/new-datastream.md): New-DataStream - [Deactivation](https://techdocs.akamai.com/powershell/docs/new-datastreamdeactivation.md): New-DataStreamDeactivation - [Data stream](https://techdocs.akamai.com/powershell/docs/set-datastream.md): Set-DataStream - [Data stream](https://techdocs.akamai.com/powershell/docs/update-datastream.md): Update-DataStream - [Data stream](https://techdocs.akamai.com/powershell/docs/remove-datastream.md): Remove-DataStream - [Validate domains](https://techdocs.akamai.com/powershell/docs/validate-domains.md) - [Function index](https://techdocs.akamai.com/powershell/docs/domain-ownership-index.md) - [Domain](https://techdocs.akamai.com/powershell/docs/complete-domdomain.md): Complete-DOMDomain - [Domain](https://techdocs.akamai.com/powershell/docs/disable-domain.md): Disable-DOMDomain - [Domain](https://techdocs.akamai.com/powershell/docs/find-domdomain.md): Find-DOMDomain - [Domain](https://techdocs.akamai.com/powershell/docs/get-domdomain.md): Get-DOMDomain - [Domain](https://techdocs.akamai.com/powershell/docs/new-domdomain.md): New-DOMDomain - [Domain](https://techdocs.akamai.com/powershell/docs/remove-domdomain.md): Remove-DOMDomain - [Diagnose content delivery issues](https://techdocs.akamai.com/powershell/docs/diagnose-content-delivery-issues.md) - [Function index](https://techdocs.akamai.com/powershell/docs/edge-diagnostics-index.md) - [IP address](https://techdocs.akamai.com/powershell/docs/find-ipaddress.md): Find-IPAddress - [Akamaized URL translation](https://techdocs.akamai.com/powershell/docs/get-edgediagnosticsurltranslation.md): Get-EdgeDiagnosticsURLTranslation - [Connectivity problems](https://techdocs.akamai.com/powershell/docs/get-edgediagnosticsconnectivityproblem.md): Get-EdgeDiagnosticsConnectivityProblem - [Content problems](https://techdocs.akamai.com/powershell/docs/get-edgediagnosticscontentproblem.md): Get-EdgeDiagnosticsContentProblem - [Diagnostic data for group](https://techdocs.akamai.com/powershell/docs/get-edgediagnosticsgroup.md): Get-EdgeDiagnosticsGroup - [Edge server locations](https://techdocs.akamai.com/powershell/docs/get-edgediagnosticslocations.md): Get-EdgeDiagnosticsLocations - [Edge server locations for metadata tracing](https://techdocs.akamai.com/powershell/docs/get-edgediagnosticsmetadatatracelocations.md): Get-EdgeDiagnosticsMetadataTraceLocations - [Error statistics](https://techdocs.akamai.com/powershell/docs/get-edgediagnosticserrorstatistics.md): Get-EdgeDiagnosticsErrorStatistics - [Error translation](https://techdocs.akamai.com/powershell/docs/get-edgediagnosticserrortranslation.md): Get-EdgeDiagnosticsErrorTranslation - [GREP request](https://techdocs.akamai.com/powershell/docs/get-edgediagnosticsgrep.md): Get-EdgeDiagnosticsGrep - [GTM properties](https://techdocs.akamai.com/powershell/docs/get-edgediagnosticsgtmproperties.md): Get-EdgeDiagnosticsGTMProperties - [GTM property IPs](https://techdocs.akamai.com/powershell/docs/get-edgediagnosticsgtmpropertyips.md): Get-EdgeDiagnosticsGTMPropertyIPs - [IPA hostnames](https://techdocs.akamai.com/powershell/docs/get-edgediagnosticsipahostnames.md): Get-EdgeDiagnosticsIPAHostnames - [Logs](https://techdocs.akamai.com/powershell/docs/get-edgediagnosticslogs.md): Get-EdgeDiagnosticsLogs - [Metadata tracer](https://techdocs.akamai.com/powershell/docs/get-edgediagnosticsmetadatatrace.md): Get-EdgeDiagnosticsMetadataTrace - [URL health check](https://techdocs.akamai.com/powershell/docs/get-edgediagnosticsurlhealthcheck.md): Get-EdgeDiagnosticsURLHealthCheck - [Connectivity problems](https://techdocs.akamai.com/powershell/docs/new-edgediagnosticsconnectivityproblem.md): New-EdgeDiagnosticsConnectivityProblem - [Content problems](https://techdocs.akamai.com/powershell/docs/new-edgediagnosticscontentproblem.md): New-EdgeDiagnosticsContentProblem - [cURL request](https://techdocs.akamai.com/powershell/docs/new-edgediagnosticscurl.md): New-EdgeDiagnosticsCurl - [Diagnostic link](https://techdocs.akamai.com/powershell/docs/new-edgediagnosticslink.md): New-EdgeDiagnosticsLink - [DIG request](https://techdocs.akamai.com/powershell/docs/new-edgediagnosticsdig.md): New-EdgeDiagnosticsDig - [Error translation](https://techdocs.akamai.com/powershell/docs/new-edgediagnosticserrortranslation.md): New-EdgeDiagnosticsErrorTranslation - [ESI debugger](https://techdocs.akamai.com/powershell/docs/new-edgediagnosticsesidebug.md): New-EdgeDiagnosticsESIDebug - [GREP request](https://techdocs.akamai.com/powershell/docs/new-edgediagnosticsgrep.md): New-EdgeDiagnosticsGrep - [Metadata trace](https://techdocs.akamai.com/powershell/docs/new-edgediagnosticsmetadatatrace.md): New-EdgeDiagnosticsMetadataTrace - [MTR request](https://techdocs.akamai.com/powershell/docs/new-edgediagnosticsmtr.md): New-EdgeDiagnosticsMTR - [URL health check](https://techdocs.akamai.com/powershell/docs/new-edgediagnosticsurlhealthcheck.md): New-EdgeDiagnosticsURLHealthCheck - [IP verification & location](https://techdocs.akamai.com/powershell/docs/test-edgediagnosticsip.md): Test-EdgeDiagnosticsIP - [Function index](https://techdocs.akamai.com/powershell/docs/edns-index.md) - [Proxy zone manual filter name](https://techdocs.akamai.com/powershell/docs/add-ednsproxyzonemanualfiltername.md): Add-EDNSProxyZoneManualFilterName - [Zone versions](https://techdocs.akamai.com/powershell/docs/compare-ednszoneversion.md): Compare-EDNSZoneVersion - [Proxy zone](https://techdocs.akamai.com/powershell/docs/convert-ednsproxyzone.md): Convert-EDNSProxyZone - [Zone to alias](https://techdocs.akamai.com/powershell/docs/convert-ednszonetoalias.md): Convert-EDNSZoneToAlias - [Zone to primary](https://techdocs.akamai.com/powershell/docs/convert-ednszonetoprimary.md): Convert-EDNSZoneToPrimary - [Zone to secondary](https://techdocs.akamai.com/powershell/docs/convert-ednszonetosecondary.md): Convert-EDNSZoneToSecondary - [Change list](https://techdocs.akamai.com/powershell/docs/find-ednschangelist.md): Find-EDNSChangeList - [Authoritative name servers](https://techdocs.akamai.com/powershell/docs/get-ednsauthority.md): Get-EDNSAuthority - [Bulk zone create results](https://techdocs.akamai.com/powershell/docs/get-ednszonebulkcreateresult.md): Get-EDNSZoneBulkCreateResult - [Bulk zone create request status](https://techdocs.akamai.com/powershell/docs/get-ednszonebulkcreatestatus.md): Get-EDNSZoneBulkCreateStatus - [Bulk zone delete request results](https://techdocs.akamai.com/powershell/docs/get-ednszonebulkdeleteresult.md): Get-EDNSZoneBulkDeleteResult - [Bulk zone delete request status](https://techdocs.akamai.com/powershell/docs/get-ednszonebulkdeletestatus.md): Get-EDNSZoneBulkDeleteStatus - [Change list](https://techdocs.akamai.com/powershell/docs/get-ednschangelist.md): Get-EDNSChangeList - [Change list diff](https://techdocs.akamai.com/powershell/docs/get-ednschangelistdiff.md): Get-EDNSChangeListDiff - [Change list settings](https://techdocs.akamai.com/powershell/docs/get-ednschangelistsettings.md): Get-EdnsChangeListSettings - [Contract](https://techdocs.akamai.com/powershell/docs/get-ednszonecontract.md): Get-EdnsZoneContract - [Contracts](https://techdocs.akamai.com/powershell/docs/get-ednscontracts.md): Get-EdnsContracts - [Convert result](https://techdocs.akamai.com/powershell/docs/get-ednsconvertresult.md) - [Convert status](https://techdocs.akamai.com/powershell/docs/get-ednsconvertstatus.md) - [DNSSEC algorithms](https://techdocs.akamai.com/powershell/docs/get-ednsdnssecalgorithms.md): Get-EdnsDNSSECAlgorithms - [DNSSEC status](https://techdocs.akamai.com/powershell/docs/get-ednszonednssecstatus.md): Get-EdnsZoneDNSSECStatus - [Edge hostnames](https://techdocs.akamai.com/powershell/docs/get-ednsedgehostnames.md): Get-EdnsEdgeHostnames - [Groups](https://techdocs.akamai.com/powershell/docs/get-ednsgroups.md): Get-EdnsGroups - [Master zone file](https://techdocs.akamai.com/powershell/docs/get-ednsmasterfile.md): Get-EdnsMasterFile - [Proxy](https://techdocs.akamai.com/powershell/docs/get-ednsproxy.md): Get-EDNSProxy - [Proxy health check](https://techdocs.akamai.com/powershell/docs/get-ednsproxyhealthcheckrecordtypes.md): Get-EDNSProxyHealthcheckRecordTypes - [Proxy zone](https://techdocs.akamai.com/powershell/docs/get-ednsproxyzone.md): Get-EDNSProxyZone - [Proxy zone create result](https://techdocs.akamai.com/powershell/docs/get-ednsproxyzonecreateresult.md): Get-EDNSProxyZoneCreateResult - [Proxy zone create status](https://techdocs.akamai.com/powershell/docs/get-ednsproxyzonecreatestatus.md): Get-EDNSProxyZoneCreateStatus - [Proxy zone delete result](https://techdocs.akamai.com/powershell/docs/get-ednsproxyzonedeleteresult.md): Get-EDNSProxyZoneDeleteResult - [Proxy zone delete status](https://techdocs.akamai.com/powershell/docs/get-ednsproxyzonedeletestatus.md): Get-EDNSProxyZoneDeleteStatus - [Proxy zone manual filter report](https://techdocs.akamai.com/powershell/docs/get-ednsproxyzonemanualfilterreport.md): Get-EDNSProxyZoneManualFilterReport - [Proxy zone TSIG key](https://techdocs.akamai.com/powershell/docs/get-ednsproxyzonetsigkey.md): Get-EDNSProxyZoneTSIGKey - [Proxy zone TSIG key use](https://techdocs.akamai.com/powershell/docs/get-ednsproxyzonetsigkeyusedby.md): Get-EDNSProxyZoneTSIGKeyUsedBy - [Record set names for change list](https://techdocs.akamai.com/powershell/docs/get-ednschangelistrecordsetnames.md): Get-EdnsChangeListRecordSetNames - [Record set types](https://techdocs.akamai.com/powershell/docs/get-ednsrecordsettypes.md): Get-EdnsRecordSetTypes - [Record set types for name and change list](https://techdocs.akamai.com/powershell/docs/get-ednschangelistrecordsettypes.md): Get-EdnsChangeListRecordSetTypes - [Record sets](https://techdocs.akamai.com/powershell/docs/get-ednsrecordset.md): Get-EdnsRecordSet - [Record sets for change list](https://techdocs.akamai.com/powershell/docs/get-ednschangelistrecordset.md): Get-EdnsChangeListRecordSet - [Secondary SOA](https://techdocs.akamai.com/powershell/docs/get-ednssecondarysoa.md): Get-EDNSSecondarySOA - [TSIG key algorithms](https://techdocs.akamai.com/powershell/docs/get-ednstsigalgorithms.md): Get-EdnsTSIGAlgorithms - [TSIG key contract](https://techdocs.akamai.com/powershell/docs/get-ednstsigkeycontract.md): Get-EDNSTSIGKeyContract - [TSIG keys](https://techdocs.akamai.com/powershell/docs/get-ednstsigkey.md): Get-EdnsTSIGKey - [Users of zone's TSIG key](https://techdocs.akamai.com/powershell/docs/get-ednstsigkeyusedby.md): Get-EdnsTSIGKeyUsedBy - [Zone](https://techdocs.akamai.com/powershell/docs/get-ednszone.md): Get-EdnsZone - [Zone's aliases](https://techdocs.akamai.com/powershell/docs/get-ednszonealias.md): Get-EdnsZoneAlias - [Zone DNS key](https://techdocs.akamai.com/powershell/docs/get-ednszonednskey.md): Get-EDNSZoneDNSKey - [Zone transfer status](https://techdocs.akamai.com/powershell/docs/get-ednszonetransferstatus.md): Get-EdnsZoneTransferStatus - [Zone version](https://techdocs.akamai.com/powershell/docs/get-ednszoneversion.md): Get-EdnsZoneVersion - [Zone version master file](https://techdocs.akamai.com/powershell/docs/get-ednszoneversionmasterfile.md) - [Zone version record set](https://techdocs.akamai.com/powershell/docs/get-ednszoneversionrecordset.md): Get-EdnsZoneVersionRecordSet - [Bulk zone create request](https://techdocs.akamai.com/powershell/docs/new-ednszonebulkcreate.md): New-EdnsZoneBulkCreate - [Bulk zone delete request](https://techdocs.akamai.com/powershell/docs/new-ednszonebulkdelete.md): New-EdnsZoneBulkDelete - [Change list](https://techdocs.akamai.com/powershell/docs/new-ednschangelist.md): New-EdnsChangeList - [Proxy](https://techdocs.akamai.com/powershell/docs/new-ednsproxy.md): New-EDNSProxy - [Proxy zone](https://techdocs.akamai.com/powershell/docs/new-ednsproxyzone.md): New-EDNSProxyZone - [Record set](https://techdocs.akamai.com/powershell/docs/new-ednsrecordset.md): New-EdnsRecordSet - [Zone](https://techdocs.akamai.com/powershell/docs/new-ednszone.md): New-EdnsZone - [Change list](https://techdocs.akamai.com/powershell/docs/remove-ednschangelist.md): Remove-EdnsChangeList - [Proxy zone](https://techdocs.akamai.com/powershell/docs/remove-ednsproxyzone.md): Remove-EDNSProxyZone - [Proxy zone apex alias](https://techdocs.akamai.com/powershell/docs/remove-ednsproxyzoneapexalias.md): Remove-EDNSProxyZoneApexAlias - [Proxy zone manual filter name](https://techdocs.akamai.com/powershell/docs/remove-ednsproxyzonemanualfiltername.md): Remove-EDNSProxyZoneManualFilterName - [Proxy zone TSIG key](https://techdocs.akamai.com/powershell/docs/remove-ednsproxyzonetsigkey.md): Remove-EDNSProxyZoneTSIGKey - [Record set](https://techdocs.akamai.com/powershell/docs/remove-ednsrecordset.md): Remove-EdnsRecordSet - [TSIG key](https://techdocs.akamai.com/powershell/docs/remove-ednstsigkey.md): Remove-EdnsTSIGKey - [Zone](https://techdocs.akamai.com/powershell/docs/remove-ednszone.md): Remove-EDNSZone - [Zone version](https://techdocs.akamai.com/powershell/docs/restore-ednszoneversion.md): Restore-EdnsZoneVersion - [Change list settings](https://techdocs.akamai.com/powershell/docs/set-ednschangelistsettings.md): Set-EdnsChangeListSettings - [Master zone file](https://techdocs.akamai.com/powershell/docs/set-ednsmasterfile.md): Set-EdnsMasterFile - [Master zone file upload to change list](https://techdocs.akamai.com/powershell/docs/set-ednschangelistmasterfile.md): Set-EdnsChangeListMasterFile - [Proxy](https://techdocs.akamai.com/powershell/docs/set-ednsproxy.md): Set-EDNSProxy - [Proxy zone apex alias](https://techdocs.akamai.com/powershell/docs/set-ednsproxyzoneapexalias.md): Set-EDNSProxyZoneApexAlias - [Proxy zone manual filter names](https://techdocs.akamai.com/powershell/docs/set-ednsproxyzonemanualfilternames.md): Set-EDNSProxyZoneManualFilterNames - [Proxy zone TSIG key](https://techdocs.akamai.com/powershell/docs/set-ednsproxyzonetsigkey.md): Set-EDNSProxyZoneTSIGKey - [Record set](https://techdocs.akamai.com/powershell/docs/set-ednsrecordset.md): Set-EdnsRecordSet - [Record set for change list](https://techdocs.akamai.com/powershell/docs/set-ednschangelistrecordset.md): Set-EdnsChangeListRecordSet - [TSIG key](https://techdocs.akamai.com/powershell/docs/set-ednstsigkey.md): Set-EdnsTSIGKey - [Zone](https://techdocs.akamai.com/powershell/docs/set-ednszone.md): Set-EdnsZone - [Change list](https://techdocs.akamai.com/powershell/docs/submit-ednschangelist.md): Submit-EdnsChangeList - [Function index](https://techdocs.akamai.com/powershell/docs/edge-hostnames-index.md) - [Edge hostname](https://techdocs.akamai.com/powershell/docs/get-edgehostname.md): Get-EdgeHostname - [Certificate](https://techdocs.akamai.com/powershell/docs/get-edgehostnamecertificate.md): Get-EdgeHostnameCertificate - [Change request](https://techdocs.akamai.com/powershell/docs/get-edgehostnamechangerequest.md): Get-EdgeHostnameChangeRequest - [Localization data](https://techdocs.akamai.com/powershell/docs/get-edgehostnamelocalizationdata.md): Get-EdgeHostnameLocalizationData - [Products](https://techdocs.akamai.com/powershell/docs/get-edgehostnameproduct.md): Get-EdgeHostnameProduct - [Edge hostname](https://techdocs.akamai.com/powershell/docs/remove-edgehostname.md): Remove-EdgeHostname - [Edge hostname](https://techdocs.akamai.com/powershell/docs/set-edgehostname.md): Set-EdgeHostname - [Manage a distributed key-value store](https://techdocs.akamai.com/powershell/docs/manage-edgekv-database.md) - [Function index](https://techdocs.akamai.com/powershell/docs/edgekv-index.md) - [Data](https://techdocs.akamai.com/powershell/docs/export-edgekvdata.md): Export-EdgeKVData - [Access token](https://techdocs.akamai.com/powershell/docs/get-edgekvaccesstoken.md): Get-EdgeKVAccessToken - [Initialization status](https://techdocs.akamai.com/powershell/docs/get-edgekvinitializationstatus.md): Get-EdgeKVInitializationStatus - [Item](https://techdocs.akamai.com/powershell/docs/get-edgekvitem.md): Get-EdgeKVItem - [Namespace](https://techdocs.akamai.com/powershell/docs/get-edgekvnamespace.md): Get-EdgeKVNamespace - [Namespace delete](https://techdocs.akamai.com/powershell/docs/get-edgekvnamespacedelete.md): Get-EdgeKVNamespaceDelete - [Namespace group](https://techdocs.akamai.com/powershell/docs/get-edgekvnamespacegroup.md): Get-EdgeKVNamespaceGroup - [Permission group](https://techdocs.akamai.com/powershell/docs/get-edgekvgroup.md): Get-EdgeKVGroup - [Upload](https://techdocs.akamai.com/powershell/docs/get-edgekvupload.md): Get-EdgeKVUpload - [Data](https://techdocs.akamai.com/powershell/docs/import-edgekvdata.md): Import-EdgeKVData - [EdgeKV](https://techdocs.akamai.com/powershell/docs/initialize-edgekv.md): Initialize-EdgeKV - [Namespace](https://techdocs.akamai.com/powershell/docs/move-edgekvnamespace.md): Move-EdgeKVNamespace - [Access token](https://techdocs.akamai.com/powershell/docs/new-edgekvaccesstoken.md): New-EdgeKVAccessToken - [Item](https://techdocs.akamai.com/powershell/docs/new-edgekvitem.md): New-EdgeKVItem - [Namespace](https://techdocs.akamai.com/powershell/docs/new-edgekvnamespace.md): New-EdgeKVNamespace - [Access token](https://techdocs.akamai.com/powershell/docs/remove-edgekvaccesstoken.md): Remove-EdgeKVAccessToken - [Item](https://techdocs.akamai.com/powershell/docs/remove-edgekvitem.md): Remove-EdgeKVItem - [Namespace](https://techdocs.akamai.com/powershell/docs/remove-edgekvnamespace.md): Remove-EdgeKVNamespace - [Namespace](https://techdocs.akamai.com/powershell/docs/restore-edgekvnamespace.md): Restore-EdgeKVNamespace - [Default data access policy](https://techdocs.akamai.com/powershell/docs/set-edgekvdefaultaccesspolicy.md): Set-EdgeKVDefaultAccessPolicy - [Namespace](https://techdocs.akamai.com/powershell/docs/set-edgekvnamespace.md): Set-EdgeKVNamespace - [Namespace delete](https://techdocs.akamai.com/powershell/docs/set-edgekvnamespacedelete.md): Set-EdgeKVNamespaceDelete - [Access token](https://techdocs.akamai.com/powershell/docs/update-edgekvaccesstoken.md): Update-EdgeKVAccessToken - [Namespace](https://techdocs.akamai.com/powershell/docs/update-edgekvnamespace.md): Update-EdgeKVNamespace - [Enable EdgeWorkers](https://techdocs.akamai.com/powershell/docs/edgeworkers.md) - [Function index](https://techdocs.akamai.com/powershell/docs/ew-index.md) - [Revisions](https://techdocs.akamai.com/powershell/docs/compare-edgeworkerrevision.md): Compare-EdgeworkerRevision - [EdgeWorker](https://techdocs.akamai.com/powershell/docs/copy-edgeworker.md): Copy-EdgeWorker - [Activation](https://techdocs.akamai.com/powershell/docs/get-edgeworkeractivation.md): Get-EdgeWorkerActivation - [Code bundle](https://techdocs.akamai.com/powershell/docs/get-edgeworkercodebundle.md): Get-EdgeWorkerCodeBundle - [Contracts](https://techdocs.akamai.com/powershell/docs/get-edgeworkercontract.md): Get-EdgeWorkerContract - [Deactivation](https://techdocs.akamai.com/powershell/docs/get-edgeworkerdeactivation.md): Get-EdgeWorkerDeactivation - [EdgeWorker](https://techdocs.akamai.com/powershell/docs/get-edgeworker.md): Get-EdgeWorker - [EdgeWorker version](https://techdocs.akamai.com/powershell/docs/get-edgeworkerversion.md): Get-EdgeWorkerVersion - [Limits](https://techdocs.akamai.com/powershell/docs/get-edgeworkerlimit.md): Get-EdgeWorkerLimit - [Logging override](https://techdocs.akamai.com/powershell/docs/get-edgeworkerloggingoverride.md): Get-EdgeWorkerLoggingOverride - [Permission group](https://techdocs.akamai.com/powershell/docs/get-edgeworkergroup.md): Get-EdgeWorkerGroup - [Properties](https://techdocs.akamai.com/powershell/docs/get-edgeworkerproperties.md): Get-EdgeWorkerProperties - [Report](https://techdocs.akamai.com/powershell/docs/get-edgeworkerreport.md): Get-EdgeWorkerReport - [Resource tiers](https://techdocs.akamai.com/powershell/docs/get-edgeworkerresourcetier.md): Get-EdgeWorkerResourceTier - [Revision](https://techdocs.akamai.com/powershell/docs/get-edgeworkerrevision.md): Get-EdgeworkerRevision - [Revision activation](https://techdocs.akamai.com/powershell/docs/get-edgeworkerrevisionactivation.md): Get-EdgeworkerRevisionActivation - [Revision BOM](https://techdocs.akamai.com/powershell/docs/get-edgeworkerrevisionbom.md): Get-EdgeworkerRevisionBom - [Revision code bundle](https://techdocs.akamai.com/powershell/docs/get-edgeworkerrevisioncodebundle.md): Get-EdgeworkerRevisionCodeBundle - [Activation](https://techdocs.akamai.com/powershell/docs/new-edgeworkeractivation.md): New-EdgeWorkerActivation - [Deactivation](https://techdocs.akamai.com/powershell/docs/new-edgeworkerdeactivation.md): New-EdgeWorkerDeactivation - [EdgeWorker](https://techdocs.akamai.com/powershell/docs/new-edgeworker.md): New-EdgeWorker - [EdgeWorker version](https://techdocs.akamai.com/powershell/docs/new-edgeworkerversion.md): New-EdgeWorkerVersion - [Revision activation](https://techdocs.akamai.com/powershell/docs/new-edgeworkerrevisionactivation.md): New-EdgeworkerRevisionActivation - [Secure token](https://techdocs.akamai.com/powershell/docs/new-edgeworkerauthtoken.md): New-EdgeWorkerAuthToken - [Logging override](https://techdocs.akamai.com/powershell/docs/new-edgeworkerloggingoverride.md): New-EdgeWorkerLoggingOverride - [Activation](https://techdocs.akamai.com/powershell/docs/remove-edgeworkeractivation.md): Remove-EdgeWorkerActivation - [EdgeWorker](https://techdocs.akamai.com/powershell/docs/remove-edgeworker.md): Remove-EdgeWorker - [EdgeWorker version](https://techdocs.akamai.com/powershell/docs/remove-edgeworkerversion.md): Remove-EdgeWorkerVersion - [EdgeWorker](https://techdocs.akamai.com/powershell/docs/set-edgeworker.md): Set-EdgeWorker - [Revision](https://techdocs.akamai.com/powershell/docs/set-edgeworkerrevision.md): Set-EdgeworkerRevision - [Code bundle](https://techdocs.akamai.com/powershell/docs/test-edgeworkercodebundle.md): Test-EdgeWorkerCodeBundle - [Activation](https://techdocs.akamai.com/powershell/docs/undo-edgeworkeractivation.md): Undo-EdgeWorkerActivation - [Manage email notifications](https://techdocs.akamai.com/powershell/docs/firewall-rules-notification.md) - [Function index](https://techdocs.akamai.com/powershell/docs/fw-rules-index.md) - [CIDR blocks](https://techdocs.akamai.com/powershell/docs/get-firewallrulescidr.md): Get-FirewallRulesCIDR - [Service](https://techdocs.akamai.com/powershell/docs/get-firewallrulesservice.md): Get-FirewallRulesService - [Subscriptions](https://techdocs.akamai.com/powershell/docs/get-firewallrulessubscription.md): Get-FirewallRulesSubscription - [Subscriptions](https://techdocs.akamai.com/powershell/docs/new-firewallrulessubscription.md): New-FirewallRulesSubscription - [Subscriptions](https://techdocs.akamai.com/powershell/docs/remove-firewallrulessubscription.md): Remove-FirewallRulesSubscription - [Subscriptions](https://techdocs.akamai.com/powershell/docs/set-firewallrulessubscription.md): Set-FirewallRulesSubscription - [Function index](https://techdocs.akamai.com/powershell/docs/gtm-index.md) - [AS map](https://techdocs.akamai.com/powershell/docs/get-gtmasmap.md): Get-GTMASMap - [CIDR map](https://techdocs.akamai.com/powershell/docs/get-gtmcidrmap.md): Get-GTMCIDRMap - [Contract](https://techdocs.akamai.com/powershell/docs/get-gtmcontract.md): Get-GTMContract - [Datacenter](https://techdocs.akamai.com/powershell/docs/get-gtmdatacenter.md): Get-GTMDatacenter - [Datacenter latency](https://techdocs.akamai.com/powershell/docs/get-gtmdatacenterlatency.md): Get-GTMDatacenterLatency - [Demand](https://techdocs.akamai.com/powershell/docs/get-gtmdemand.md): Get-GTMDemand - [Domain](https://techdocs.akamai.com/powershell/docs/get-gtmdomain.md): Get-GTMDomain - [Domain authorities](https://techdocs.akamai.com/powershell/docs/get-gtmdomainauthority.md): Get-GTMDomainAuthority - [Domain history](https://techdocs.akamai.com/powershell/docs/get-gtmdomainhistory.md): Get-GTMDomainHistory - [Domain list](https://techdocs.akamai.com/powershell/docs/get-gtmdomainlist.md): Get-GTMDomainList - [Domain status](https://techdocs.akamai.com/powershell/docs/get-gtmdomainstatus.md): Get-GTMDomainStatus - [Domain summary](https://techdocs.akamai.com/powershell/docs/get-gtmdomainsummary.md): Get-GTMDomainSummary - [Geo map](https://techdocs.akamai.com/powershell/docs/get-gtmgeomap.md): Get-GTMGeoMap - [Group](https://techdocs.akamai.com/powershell/docs/get-gtmgroup.md): Get-GTMGroup - [Identity](https://techdocs.akamai.com/powershell/docs/get-gtmidentity.md): Get-GTMIdentity - [IP availability per property](https://techdocs.akamai.com/powershell/docs/get-gtmipavailability.md): Get-GTMIPAvailability - [Liveness tests per property](https://techdocs.akamai.com/powershell/docs/get-gtmlivenessperproperty.md): Get-GTMLivenessPerProperty - [Liveness test error](https://techdocs.akamai.com/powershell/docs/get-gtmlivenesstesterror.md): Get-GTMLivenessTestError - [Load data](https://techdocs.akamai.com/powershell/docs/get-gtmloaddata.md): Get-GTMLoadData - [Load feedback report](https://techdocs.akamai.com/powershell/docs/get-gtmloadfeedbackreport.md): Get-GTMLoadFeedbackReport - [Property](https://techdocs.akamai.com/powershell/docs/get-gtmproperty.md): Get-GTMProperty - [Resource](https://techdocs.akamai.com/powershell/docs/get-gtmresource.md): Get-GTMResource - [Traffic report per datacenter](https://techdocs.akamai.com/powershell/docs/get-gtmtrafficperdatacenter.md): Get-GTMTrafficPerDatacenter - [Traffic report per property](https://techdocs.akamai.com/powershell/docs/get-gtmtrafficperproperty.md): Get-GTMTrafficPerProperty - [AS map](https://techdocs.akamai.com/powershell/docs/new-gtmasmap.md): New-GTMASMap - [CIDR map](https://techdocs.akamai.com/powershell/docs/new-gtmcidrmap.md): New-GTMCIDRMap - [Datacenter](https://techdocs.akamai.com/powershell/docs/new-gtmdatacenter.md): New-GTMDatacenter - [Default datacenter](https://techdocs.akamai.com/powershell/docs/new-gtmdefaultdatacenter.md): New-GTMDefaultDatacenter - [Default IP datacenter](https://techdocs.akamai.com/powershell/docs/new-gtmdefaultdatacenterforip.md): New-GTMDefaultDatacenterForIP - [Domain](https://techdocs.akamai.com/powershell/docs/new-gtmdomain.md): New-GTMDomain - [Geo map](https://techdocs.akamai.com/powershell/docs/new-gtmgeomap.md): New-GTMGeoMap - [Property](https://techdocs.akamai.com/powershell/docs/new-gtmproperty.md): New-GTMProperty - [Resource](https://techdocs.akamai.com/powershell/docs/new-gtmresource.md): New-GTMResource - [AS map](https://techdocs.akamai.com/powershell/docs/remove-gtmasmap.md): Remove-GTMASMap - [CIDR map](https://techdocs.akamai.com/powershell/docs/remove-gtmcidrmap.md): Remove-GTMCIDRMap - [Datacenter](https://techdocs.akamai.com/powershell/docs/remove-gtmdatacenter.md): Remove-GTMDatacenter - [Geo map](https://techdocs.akamai.com/powershell/docs/remove-gtmgeomap.md): Remove-GTMGeoMap - [Property](https://techdocs.akamai.com/powershell/docs/remove-gtmproperty.md): Remove-GTMProperty - [Resource](https://techdocs.akamai.com/powershell/docs/remove-gtmresource.md): Remove-GTMResource - [AS map](https://techdocs.akamai.com/powershell/docs/set-gtmasmap.md): Set-GTMASMap - [CIDR map](https://techdocs.akamai.com/powershell/docs/set-gtmcidrmap.md): Set-GTMCIDRMap - [Datacenter](https://techdocs.akamai.com/powershell/docs/set-gtmdatacenter.md): Set-GTMDatacenter - [Domain](https://techdocs.akamai.com/powershell/docs/set-gtmdomain.md): Set-GTMDomain - [Geo map](https://techdocs.akamai.com/powershell/docs/set-gtmgeomap.md): Set-GTMGeoMap - [Property](https://techdocs.akamai.com/powershell/docs/set-gtmproperty.md): Set-GTMProperty - [Resource](https://techdocs.akamai.com/powershell/docs/set-gtmresource.md): Set-GTMResource - [Load data](https://techdocs.akamai.com/powershell/docs/submit-gtmloaddata.md): Submit-GTMLoadData - [Control access](https://techdocs.akamai.com/powershell/docs/identity-access.md) - [User](https://techdocs.akamai.com/powershell/docs/iam-user.md) - [Admin](https://techdocs.akamai.com/powershell/docs/iam-admin.md) - [Function index](https://techdocs.akamai.com/powershell/docs/iam-index.md) - [Property users](https://techdocs.akamai.com/powershell/docs/block-iampropertyusers.md): Block-IAMPropertyUsers - [API credential](https://techdocs.akamai.com/powershell/docs/disable-iamapicredential.md): Disable-IAMAPICredential - [IP allowlist](https://techdocs.akamai.com/powershell/docs/disable-iamipallowlist.md): Disable-IAMIPAllowList - [IP allowlist](https://techdocs.akamai.com/powershell/docs/enable-iamipallowlist.md): Enable-IAMIPAllowList - [Accessible groups](https://techdocs.akamai.com/powershell/docs/get-iamaccessiblegroups.md): Get-IAMAccessibleGroups - [Account switch key](https://techdocs.akamai.com/powershell/docs/get-accountswitchkey.md): Get-AccountSwitchKey - [Admin contact types](https://techdocs.akamai.com/powershell/docs/get-iamadmincontacttypes.md): Get-IAMAdminContactTypes - [Admin countries](https://techdocs.akamai.com/powershell/docs/get-iamadmincountries.md): Get-IAMAdminCountries - [Admin languages](https://techdocs.akamai.com/powershell/docs/get-iamadminlanguages.md): Get-IAMAdminLanguages - [Admin password policy](https://techdocs.akamai.com/powershell/docs/get-iamadminpasswordpolicy.md): Get-IAMAdminPasswordPolicy - [Admin products](https://techdocs.akamai.com/powershell/docs/get-iamadminproducts.md): Get-IAMAdminProducts - [Admin states](https://techdocs.akamai.com/powershell/docs/get-iamadminstates.md): Get-IAMAdminStates - [Admin timeout policy](https://techdocs.akamai.com/powershell/docs/get-iamadmintimeoutpolicy.md): Get-IAMAdminTimeoutPolicy - [Admin time zones](https://techdocs.akamai.com/powershell/docs/get-iamadmintimezones.md): Get-IAMAdminTimeZones - [Allowed APIs](https://techdocs.akamai.com/powershell/docs/get-iamallowedapis.md): Get-IAMAllowedAPIs - [Allowed CP codes](https://techdocs.akamai.com/powershell/docs/get-iamallowedcpcodes.md): Get-IAMAllowedCPCodes - [API client](https://techdocs.akamai.com/powershell/docs/get-iamapiclient.md): Get-IAMAPIClient - [API credential](https://techdocs.akamai.com/powershell/docs/get-iamapicredential.md): Get-IAMAPICredential - [Authorized users](https://techdocs.akamai.com/powershell/docs/get-iamauthorizedusers.md): Get-IAMAuthorizedUsers - [Blocked properties](https://techdocs.akamai.com/powershell/docs/get-iamuserblockedproperties.md): Get-IAMUserBlockedProperties - [CIDR block](https://techdocs.akamai.com/powershell/docs/get-iamcidrblock.md): Get-IAMCIDRBlock - [Grantable roles](https://techdocs.akamai.com/powershell/docs/get-iamgrantablerole.md): Get-IAMGrantableRole - [Group](https://techdocs.akamai.com/powershell/docs/get-iamgroup.md): Get-IAMGroup - [IP allowlist status](https://techdocs.akamai.com/powershell/docs/get-iamipallowliststatus.md): Get-IAMIPAllowListStatus - [Property](https://techdocs.akamai.com/powershell/docs/get-iamproperty.md): Get-IAMProperty - [Property resources](https://techdocs.akamai.com/powershell/docs/get-iampropertyresources.md): Get-IAMPropertyResources - [Property users](https://techdocs.akamai.com/powershell/docs/get-iampropertyusers.md): Get-IAMPropertyUsers - [Role](https://techdocs.akamai.com/powershell/docs/get-iamrole.md): Get-IAMRole - [User](https://techdocs.akamai.com/powershell/docs/get-iamuser.md): Get-IAMUser - [Users affected by moving group](https://techdocs.akamai.com/powershell/docs/get-iamgroupmoveaffectedusers.md): Get-IAMGroupMoveAffectedUsers - [User contact types](https://techdocs.akamai.com/powershell/docs/get-iamusercontacttypes.md): Get-IAMUserContactTypes - [User countries](https://techdocs.akamai.com/powershell/docs/get-iamusercountries.md): Get-IAMUserCountries - [User languages](https://techdocs.akamai.com/powershell/docs/get-iamuserlanguages.md): Get-IAMUserLanguages - [User password policy](https://techdocs.akamai.com/powershell/docs/get-iamuserpasswordpolicy.md): Get-IAMUserPasswordPolicy - [User products](https://techdocs.akamai.com/powershell/docs/get-iamuserproducts.md): Get-IAMUserProducts - [User profile](https://techdocs.akamai.com/powershell/docs/get-iamuserprofile.md): Get-IAMUserProfile - [User states](https://techdocs.akamai.com/powershell/docs/get-iamuserstates.md): Get-IAMUserStates - [User timeout policy](https://techdocs.akamai.com/powershell/docs/get-iamusertimeoutpolicy.md): Get-IAMUserTimeoutPolicy - [User time zones](https://techdocs.akamai.com/powershell/docs/get-iamusertimezones.md): Get-IAMUserTimeZones - [API client](https://techdocs.akamai.com/powershell/docs/lock-iamapiclient.md): Lock-IAMAPIClient - [User](https://techdocs.akamai.com/powershell/docs/lock-iamuser.md): Lock-IAMUser - [Group](https://techdocs.akamai.com/powershell/docs/move-iamgroup.md): Move-IAMGroup - [Property](https://techdocs.akamai.com/powershell/docs/move-iamproperty.md): Move-IAMProperty - [API client](https://techdocs.akamai.com/powershell/docs/new-iamapiclient.md): New-IAMAPIClient - [API credential](https://techdocs.akamai.com/powershell/docs/new-iamapicredential.md): New-IAMAPICredential - [CIDR block](https://techdocs.akamai.com/powershell/docs/new-iamcidrblock.md): New-IAMCIDRBlock - [Group](https://techdocs.akamai.com/powershell/docs/new-iamgroup.md): New-IAMGroup - [Role](https://techdocs.akamai.com/powershell/docs/new-iamrole.md): New-IAMRole - [User](https://techdocs.akamai.com/powershell/docs/new-iamuser.md): New-IAMUser - [API client](https://techdocs.akamai.com/powershell/docs/remove-iamapiclient.md): Remove-IAMAPIClient - [API credential](https://techdocs.akamai.com/powershell/docs/remove-iamapicredential.md): Remove-IAMAPICredential - [CIDR block](https://techdocs.akamai.com/powershell/docs/remove-iamcidrblock.md): Remove-IAMCIDRBlock - [Group](https://techdocs.akamai.com/powershell/docs/remove-iamgroup.md): Remove-IAMGroup - [Role](https://techdocs.akamai.com/powershell/docs/remove-iamrole.md): Remove-IAMRole - [User](https://techdocs.akamai.com/powershell/docs/remove-iamuser.md): Remove-IAMUser - [Multi-factor authentication](https://techdocs.akamai.com/powershell/docs/reset-iamusermfa.md): Reset-IAMUserMFA - [User password](https://techdocs.akamai.com/powershell/docs/reset-iamuserpassword.md): Reset-IAMUserPassword - [API client](https://techdocs.akamai.com/powershell/docs/set-iamapiclient.md): Set-IAMAPIClient - [API credential](https://techdocs.akamai.com/powershell/docs/set-iamapicredential.md): Set-IAMAPICredential - [Blocked properties](https://techdocs.akamai.com/powershell/docs/set-iamuserblockedproperties.md): Set-IAMUserBlockedProperties - [CIDR block](https://techdocs.akamai.com/powershell/docs/set-iamcidrblock.md): Set-IAMCIDRBlock - [Group](https://techdocs.akamai.com/powershell/docs/set-iamgroup.md): Set-IAMGroup - [Group & role assignments](https://techdocs.akamai.com/powershell/docs/set-iamusergroupandrole.md): Set-IAMUserGroupAndRole - [Multi-factor authentication](https://techdocs.akamai.com/powershell/docs/set-iamusermfa.md): Set-IAMUserMFA - [Role](https://techdocs.akamai.com/powershell/docs/set-iamrole.md): Set-IAMRole - [User](https://techdocs.akamai.com/powershell/docs/set-iamuser.md): Set-IAMUser - [User notifications](https://techdocs.akamai.com/powershell/docs/set-iamusernotifications.md): Set-IAMUserNotifications - [User password](https://techdocs.akamai.com/powershell/docs/set-iamuserpassword.md): Set-IAMUserPassword - [User profile](https://techdocs.akamai.com/powershell/docs/set-iamuserprofile.md): Set-IAMUserProfile - [CIDR block](https://techdocs.akamai.com/powershell/docs/test-iamcidrblock.md): Test-IAMCIDRBlock - [API client](https://techdocs.akamai.com/powershell/docs/unlock-iamapiclient.md): Unlock-IAMAPIClient - [User](https://techdocs.akamai.com/powershell/docs/unlock-iamuser.md): Unlock-IAMUser - [Manage policy rules](https://techdocs.akamai.com/powershell/docs/add-and-maintain-policy-rules.md) - [Transform images](https://techdocs.akamai.com/powershell/docs/transform-images.md) - [Function index](https://techdocs.akamai.com/powershell/docs/ivm-index.md) - [Error details](https://techdocs.akamai.com/powershell/docs/get-ivmerrordetails.md): Get-IVMErrorDetails - [Image](https://techdocs.akamai.com/powershell/docs/get-ivmimage.md): Get-IVMImage - [Log details](https://techdocs.akamai.com/powershell/docs/get-ivmlogdetails.md): Get-IVMLogDetails - [Policy](https://techdocs.akamai.com/powershell/docs/get-ivmpolicy.md): Get-IVMPolicy - [Policy history](https://techdocs.akamai.com/powershell/docs/get-ivmpolicyhistory.md): Get-IVMPolicyHistory - [Policy set](https://techdocs.akamai.com/powershell/docs/get-ivmpolicyset.md): Get-IVMPolicySet - [Policy](https://techdocs.akamai.com/powershell/docs/new-ivmpolicy.md): New-IVMPolicy - [Policy set](https://techdocs.akamai.com/powershell/docs/new-ivmpolicyset.md): New-IVMPolicySet - [Policy](https://techdocs.akamai.com/powershell/docs/restore-ivmpolicy.md): Restore-IVMPolicy - [Policy](https://techdocs.akamai.com/powershell/docs/remove-ivmpolicy.md): Remove-IVMPolicy - [Policy set](https://techdocs.akamai.com/powershell/docs/remove-ivmpolicyset.md): Remove-IVMPolicySet - [Policy](https://techdocs.akamai.com/powershell/docs/set-ivmpolicy.md): Set-IVMPolicy - [Policy set](https://techdocs.akamai.com/powershell/docs/set-ivmpolicyset.md): Set-IVMPolicySet - [Function index](https://techdocs.akamai.com/powershell/docs/msl-index.md) - [CDNs](https://techdocs.akamai.com/powershell/docs/get-mslcdn.md): Get-MSLCDN - [Contracts](https://techdocs.akamai.com/powershell/docs/get-mslcontract.md): Get-MSLContract - [CP codes per origin](https://techdocs.akamai.com/powershell/docs/get-mslorigincpcode.md): Get-MSLOriginCPCode - [CP codes per type](https://techdocs.akamai.com/powershell/docs/get-mslcpcode.md): Get-MSLCPCode - [Migration](https://techdocs.akamai.com/powershell/docs/get-mslmigration.md): Get-MSLMigration - [Origin](https://techdocs.akamai.com/powershell/docs/get-mslorigin.md): Get-MSLOrigin - [Publishing locations](https://techdocs.akamai.com/powershell/docs/get-mslpublishinglocations.md): Get-MSLPublishingLocations - [Stream](https://techdocs.akamai.com/powershell/docs/get-mslstream.md): Get-MSLStream - [VOD origins](https://techdocs.akamai.com/powershell/docs/get-mslvodorigin.md): Get-MSLVODOrigin - [CP code](https://techdocs.akamai.com/powershell/docs/new-mslcpcode.md): New-MSLCPCode - [Key](https://techdocs.akamai.com/powershell/docs/new-mslkey.md): New-MSLKey - [Migration](https://techdocs.akamai.com/powershell/docs/new-mslmigration.md): New-MSLMigration - [Origin](https://techdocs.akamai.com/powershell/docs/new-mslorigin.md): New-MSLOrigin - [Stream](https://techdocs.akamai.com/powershell/docs/new-mslstream.md): New-MSLStream - [Origin](https://techdocs.akamai.com/powershell/docs/remove-mslorigin.md): Remove-MSLOrigin - [Stream](https://techdocs.akamai.com/powershell/docs/remove-mslstream.md): Remove-MSLStream - [Origin](https://techdocs.akamai.com/powershell/docs/set-mslorigin.md): Set-MSLOrigin - [Stream](https://techdocs.akamai.com/powershell/docs/set-mslstream.md): Set-MSLStream - [Migration](https://techdocs.akamai.com/powershell/docs/undo-mslmigration.md): Undo-MSLMigration - [Manage certificate authority sets](https://techdocs.akamai.com/powershell/docs/manage-ca-sets.md) - [Function index](https://techdocs.akamai.com/powershell/docs/mets-index.md) - [CA set ](https://techdocs.akamai.com/powershell/docs/copy-metscaset.md): Copy-METSCASet - [CA set version](https://techdocs.akamai.com/powershell/docs/copy-metscasetversion.md): Copy-METSCASetVersion - [CA set](https://techdocs.akamai.com/powershell/docs/get-metscaset.md): Get-METSCASet - [CA set activation](https://techdocs.akamai.com/powershell/docs/get-metscasetactivation.md): Get-METSCASetActivation - [CA set activities](https://techdocs.akamai.com/powershell/docs/get-metscasetactivities.md): Get-METSCASetActivities - [CA set association](https://techdocs.akamai.com/powershell/docs/get-metscasetassociation.md): Get-METSCASetAssociation - [CA set deletion requests](https://techdocs.akamai.com/powershell/docs/get-metsremoval.md): Get-METSRemoval - [CA set version](https://techdocs.akamai.com/powershell/docs/get-metscasetversion.md): Get-METSCASetVersion - [CA set version certificate](https://techdocs.akamai.com/powershell/docs/get-metscasetversioncertificate.md): Get-METSCASetVersionCertificate - [CA set](https://techdocs.akamai.com/powershell/docs/new-metscaset.md): New-METSCASet - [CA set activation](https://techdocs.akamai.com/powershell/docs/new-metscasetactivation.md): New-METSCASetActivation - [CA set deactivation](https://techdocs.akamai.com/powershell/docs/new-metscasetdeactivation.md): New-METSCASetDeactivation - [CA set version](https://techdocs.akamai.com/powershell/docs/new-metscasetversion.md): New-METSCASetVersion - [CA set](https://techdocs.akamai.com/powershell/docs/remove-metscaset.md): Remove-METSCASet - [CA set version](https://techdocs.akamai.com/powershell/docs/remove-metscasetversion.md): Remove-METSCASetVersion - [CA set version](https://techdocs.akamai.com/powershell/docs/set-metscasetversion.md): Set-METSCASetVersion - [Test version](https://techdocs.akamai.com/powershell/docs/test-metscasetversion.md): Test-METSCASetVersion - [Manage client certificates](https://techdocs.akamai.com/powershell/docs/manage-client-certificates.md) - [Function index](https://techdocs.akamai.com/powershell/docs/moks-index.md) - [Client cert version](https://techdocs.akamai.com/powershell/docs/complete-moksclientcertversion.md): Complete-MOKSClientCertVersion - [CA cert](https://techdocs.akamai.com/powershell/docs/get-mokscacert.md): Get-MOKSCACert - [Client cert](https://techdocs.akamai.com/powershell/docs/get-moksclientcert.md): Get-MOKSClientCert - [Client cert version](https://techdocs.akamai.com/powershell/docs/get-moksclientcertversion.md): Get-MOKSClientCertVersion - [Client cert](https://techdocs.akamai.com/powershell/docs/new-moksclientcert.md): New-MOKSClientCert - [Client cert version](https://techdocs.akamai.com/powershell/docs/new-moksclientcertversion.md): New-MOKSClientCertVersion - [Client cert version](https://techdocs.akamai.com/powershell/docs/remove-moksclientcertversion.md): Remove-MOKSClientCertVersion - [Client cert](https://techdocs.akamai.com/powershell/docs/set-moksclientcert.md): Set-MOKSClientCert - [Provision storage](https://techdocs.akamai.com/powershell/docs/netstorage.md) - [Configuration](https://techdocs.akamai.com/powershell/docs/configuration.md) - [Function index](https://techdocs.akamai.com/powershell/docs/ns-index.md) - [FTP key](https://techdocs.akamai.com/powershell/docs/add-netstorageuploadaccountftpkey.md): Add-NetstorageUploadAccountFTPKey - [HTTP key](https://techdocs.akamai.com/powershell/docs/add-netstorageuploadaccounthttpkey.md): Add-NetstorageUploadAccountHTTPKey - [Rsync key](https://techdocs.akamai.com/powershell/docs/add-netstorageuploadaccountrsynckey.md): Add-NetstorageUploadAccountRSyncKey - [SSH key](https://techdocs.akamai.com/powershell/docs/add-netstorageuploadaccountsshkey.md): Add-NetstorageUploadAccountSSHKey - [FTP key](https://techdocs.akamai.com/powershell/docs/disable-netstorageuploadaccountftpkey.md): Disable-NetstorageUploadAccountFTPKey - [HTTP key](https://techdocs.akamai.com/powershell/docs/disable-netstorageuploadaccounthttpkey.md): Disable-NetstorageUploadAccountHTTPKey - [Rsync key](https://techdocs.akamai.com/powershell/docs/disable-netstorageuploadaccountrsynckey.md): Disable-NetstorageUploadAccountRSyncKey - [SSH key](https://techdocs.akamai.com/powershell/docs/disable-netstorageuploadaccountsshkey.md): Disable-NetstorageUploadAccountSSHKey - [Upload account](https://techdocs.akamai.com/powershell/docs/disable-netstorageuploadaccount.md): Disable-NetstorageUploadAccount - [FTP key](https://techdocs.akamai.com/powershell/docs/enable-netstorageuploadaccountftpkey.md): Enable-NetstorageUploadAccountFTPKey - [HTTP key](https://techdocs.akamai.com/powershell/docs/enable-netstorageuploadaccounthttpkey.md): Enable-NetstorageUploadAccountHTTPKey - [Rsync key](https://techdocs.akamai.com/powershell/docs/enable-netstorageuploadaccountrsynckey.md): Enable-NetstorageUploadAccountRSyncKey - [SSH key](https://techdocs.akamai.com/powershell/docs/enable-netstorageuploadaccountsshkey.md): Enable-NetstorageUploadAccountSSHKey - [Upload account](https://techdocs.akamai.com/powershell/docs/enable-netstorageuploadaccount.md): Enable-NetstorageUploadAccount - [CP code](https://techdocs.akamai.com/powershell/docs/get-netstoragecpcode.md): Get-NetstorageCPCode - [Directory](https://techdocs.akamai.com/powershell/docs/get-netstoragedirectory.md): Get-NetstorageDirectory - [Directory usage](https://techdocs.akamai.com/powershell/docs/get-netstoragedirectoryusage.md): Get-NetstorageDirectoryUsage - [Group](https://techdocs.akamai.com/powershell/docs/get-netstoragegroup.md): Get-NetstorageGroup - [Purge routine](https://techdocs.akamai.com/powershell/docs/get-netstoragecpcodepurgeroutine.md): Get-NetstorageCPCodePurgeRoutine - [Rule set](https://techdocs.akamai.com/powershell/docs/get-netstorageruleset.md): Get-NetstorageRuleSet - [Snapshot](https://techdocs.akamai.com/powershell/docs/get-netstoragesnapshot.md): Get-NetstorageSnapshot - [Upload account](https://techdocs.akamai.com/powershell/docs/get-netstorageuploadaccount.md): Get-NetstorageUploadAccount - [Zones](https://techdocs.akamai.com/powershell/docs/get-netstoragezones.md): Get-NetstorageZones - [Object](https://techdocs.akamai.com/powershell/docs/measure-netstorageobject.md): Measure-NetstorageObject - [CP code](https://techdocs.akamai.com/powershell/docs/new-netstoragecpcode.md): New-NetstorageCPCode - [Credentials](https://techdocs.akamai.com/powershell/docs/new-netstoragecredentials.md) - [Directory](https://techdocs.akamai.com/powershell/docs/new-netstoragedirectory.md): New-NetstorageDirectory - [Group](https://techdocs.akamai.com/powershell/docs/new-netstoragegroup.md): New-NetstorageGroup - [Rule set](https://techdocs.akamai.com/powershell/docs/new-netstorageruleset.md): New-NetstorageRuleSet - [Snapshot](https://techdocs.akamai.com/powershell/docs/new-netstoragesnapshot.md): New-NetstorageSnapshot - [Symlink](https://techdocs.akamai.com/powershell/docs/new-netstoragesymlink.md): New-NetstorageSymlink - [Upload account](https://techdocs.akamai.com/powershell/docs/new-netstorageuploadaccount.md): New-NetstorageUploadAccount - [Directory](https://techdocs.akamai.com/powershell/docs/read-netstoragedirectory.md): Read-NetstorageDirectory - [Object](https://techdocs.akamai.com/powershell/docs/read-netstorageobject.md): Read-NetstorageObject - [CP code](https://techdocs.akamai.com/powershell/docs/remove-netstoragecpcode.md): Remove-NetstorageCPCode - [Directory](https://techdocs.akamai.com/powershell/docs/remove-netstoragedirectory.md): Remove-NetstorageDirectory - [FTP key](https://techdocs.akamai.com/powershell/docs/remove-netstorageuploadaccountftpkey.md): Remove-NetstorageUploadAccountFTPKey - [Group](https://techdocs.akamai.com/powershell/docs/remove-netstoragegroup.md): Remove-NetstorageGroup - [HTTP key](https://techdocs.akamai.com/powershell/docs/remove-netstorageuploadaccounthttpkey.md): Remove-NetstorageUploadAccountHTTPKey - [Object](https://techdocs.akamai.com/powershell/docs/remove-netstorageobject.md): Remove-NetstorageObject - [Purge routine](https://techdocs.akamai.com/powershell/docs/remove-netstoragecpcodepurgeroutine.md): Remove-NetstorageCPCodePurgeRoutine - [Rule set](https://techdocs.akamai.com/powershell/docs/remove-netstorageruleset.md): Remove-NetstorageRuleSet - [Rsync key](https://techdocs.akamai.com/powershell/docs/remove-netstorageuploadaccountrsynckey.md): Remove-NetstorageUploadAccountRSyncKey - [Snapshot](https://techdocs.akamai.com/powershell/docs/remove-netstoragesnapshot.md): Remove-NetstorageSnapshot - [SSHKey](https://techdocs.akamai.com/powershell/docs/remove-netstorageuploadaccountsshkey.md): Remove-NetstorageUploadAccountSSHKey - [Object](https://techdocs.akamai.com/powershell/docs/rename-netstorageobject.md): Rename-NetstorageObject - [FTP key](https://techdocs.akamai.com/powershell/docs/set-netstorageuploadaccountftpkey.md): Set-NetstorageUploadAccountFTPKey - [Group](https://techdocs.akamai.com/powershell/docs/set-netstoragegroup.md): Set-NetstorageGroup - [Object modification time](https://techdocs.akamai.com/powershell/docs/set-netstorageobjectmtime.md): Set-NetstorageObjectMTime - [Purge routine](https://techdocs.akamai.com/powershell/docs/set-netstoragecpcodepurgeroutine.md): Set-NetstorageCPCodePurgeRoutine - [Rule set](https://techdocs.akamai.com/powershell/docs/set-netstorageruleset.md): Set-NetstorageRuleSet - [Snapshot](https://techdocs.akamai.com/powershell/docs/set-netstoragesnapshot.md): Set-NetstorageSnapshot - [Upload account](https://techdocs.akamai.com/powershell/docs/set-netstorageuploadaccount.md): Set-NetstorageUploadAccount - [Snapshot](https://techdocs.akamai.com/powershell/docs/start-netstoragesnapshot.md): Start-NetstorageSnapshot - [FTP key](https://techdocs.akamai.com/powershell/docs/update-netstorageuploadaccountftpkey.md): Update-NetstorageUploadAccountFTPKey - [Object](https://techdocs.akamai.com/powershell/docs/write-netstorageobject.md): Write-NetstorageObject - [CP code](https://techdocs.akamai.com/powershell/docs/restore-netstoragecpcode.md): Restore-NetstorageCPCode - [Group](https://techdocs.akamai.com/powershell/docs/restore-netstoragegroup.md): Restore-NetstorageGroup - [Configure network lists](https://techdocs.akamai.com/powershell/docs/configure-network-lists.md) - [Function index](https://techdocs.akamai.com/powershell/docs/nl-index.md) - [Item](https://techdocs.akamai.com/powershell/docs/add-networklistitem.md): Add-NetworkListItem - [Activation](https://techdocs.akamai.com/powershell/docs/new-networklistactivation.md): New-NetworkListActivation - [Network list](https://techdocs.akamai.com/powershell/docs/new-networklist.md): New-NetworkList - [Subscription](https://techdocs.akamai.com/powershell/docs/new-networklistsubscription.md): New-NetworkListSubscription - [Activation](https://techdocs.akamai.com/powershell/docs/get-networklistactivation.md): Get-NetworkListActivation - [Activation status](https://techdocs.akamai.com/powershell/docs/get-networklistactivationstatus.md): Get-NetworkListActivationStatus - [Network list](https://techdocs.akamai.com/powershell/docs/get-networklist.md): Get-NetworkList - [Snapshot](https://techdocs.akamai.com/powershell/docs/get-networklistsnapshot.md): Get-NetworkListSnapshot - [Network list](https://techdocs.akamai.com/powershell/docs/set-networklist.md): Set-NetworkList - [Item](https://techdocs.akamai.com/powershell/docs/remove-networklistitem.md): Remove-NetworkListItem - [Network list](https://techdocs.akamai.com/powershell/docs/remove-networklist.md): Remove-NetworkList - [Subscription](https://techdocs.akamai.com/powershell/docs/remove-networklistsubscription.md): Remove-NetworkListSubscription - [Properties](https://techdocs.akamai.com/powershell/docs/properties.md) - [Rules](https://techdocs.akamai.com/powershell/docs/rules.md) - [Includes](https://techdocs.akamai.com/powershell/docs/includes.md) - [Function index](https://techdocs.akamai.com/powershell/docs/property-index.md) - [Bucket hostname](https://techdocs.akamai.com/powershell/docs/add-buckethostname.md): Add-BucketHostname - [Include rule](https://techdocs.akamai.com/powershell/docs/add-propertyincluderule.md): Add-PropertyIncludeRule - [Property hostname](https://techdocs.akamai.com/powershell/docs/add-propertyhostname.md): Add-PropertyHostname - [Property rule](https://techdocs.akamai.com/powershell/docs/add-propertyrule.md): Add-PropertyRule - [Bucket hostname](https://techdocs.akamai.com/powershell/docs/compare-buckethostname.md): Compare-BucketHostname - [Property](https://techdocs.akamai.com/powershell/docs/copy-property.md): Copy-Property - [Include](https://techdocs.akamai.com/powershell/docs/copy-propertyinclude.md): Copy-PropertyInclude - [Property](https://techdocs.akamai.com/powershell/docs/find-property.md): Find-Property - [Account ID](https://techdocs.akamai.com/powershell/docs/get-accountid.md): Get-AccountID - [Bucket activation](https://techdocs.akamai.com/powershell/docs/get-bucketactivation.md): Get-BucketActivation - [Bucket hostname](https://techdocs.akamai.com/powershell/docs/get-buckethostname.md): Get-BucketHostname - [Bulk activated property](https://techdocs.akamai.com/powershell/docs/get-bulkactivatedproperty.md): Get-BulkActivatedProperty - [Bulk-patched property](https://techdocs.akamai.com/powershell/docs/get-bulkpatchedproperty.md): Get-BulkPatchedProperty - [Bulk search result](https://techdocs.akamai.com/powershell/docs/get-bulksearchresult.md): Get-BulkSearchResult - [Bulk-versioned property](https://techdocs.akamai.com/powershell/docs/get-bulkversionedproperty.md): Get-BulkVersionedProperty - [Child rule snippet](https://techdocs.akamai.com/powershell/docs/get-childrulesnippet.md): Get-ChildRuleSnippet - [Custom behavior](https://techdocs.akamai.com/powershell/docs/get-custombehavior.md): Get-CustomBehavior - [Custom override](https://techdocs.akamai.com/powershell/docs/get-customoverride.md): Get-CustomOverride - [CP code](https://techdocs.akamai.com/powershell/docs/get-propertycpcode.md): Get-PropertyCPCode - [Domain ownership challenge](https://techdocs.akamai.com/powershell/docs/get-propertydomainownershipchallenge.md): Get-PropertyDomainOwnershipChallenge - [Edge hostname](https://techdocs.akamai.com/powershell/docs/get-propertyedgehostname.md): Get-PropertyEdgeHostname - [Group](https://techdocs.akamai.com/powershell/docs/get-group.md): Get-Group - [Hostname audit history](https://techdocs.akamai.com/powershell/docs/get-hostnameaudithistory.md): Get-HostnameAuditHistory - [Include](https://techdocs.akamai.com/powershell/docs/get-propertyinclude.md): Get-PropertyInclude - [Include activation](https://techdocs.akamai.com/powershell/docs/get-propertyincludeactivation.md): Get-PropertyIncludeActivation - [Include behaviors](https://techdocs.akamai.com/powershell/docs/get-propertyincludebehaviors.md): Get-PropertyIncludeBehaviors - [Include criteria](https://techdocs.akamai.com/powershell/docs/get-propertyincludecriteria.md): Get-PropertyIncludeCriteria - [Include parent](https://techdocs.akamai.com/powershell/docs/get-propertyincludeparent.md): Get-PropertyIncludeParent - [Include rules](https://techdocs.akamai.com/powershell/docs/get-propertyincluderules.md): Get-PropertyIncludeRules - [Include rules digest](https://techdocs.akamai.com/powershell/docs/get-propertyincluderulesdigest.md): Get-PropertyIncludeRulesDigest - [Include version](https://techdocs.akamai.com/powershell/docs/get-propertyincludeversion.md): Get-PropertyIncludeVersion - [Product](https://techdocs.akamai.com/powershell/docs/get-product.md): Get-Product - [Property](https://techdocs.akamai.com/powershell/docs/get-property.md): Get-Property - [Property activation](https://techdocs.akamai.com/powershell/docs/get-propertyactivation.md): Get-PropertyActivation - [Property behaviors](https://techdocs.akamai.com/powershell/docs/get-propertybehaviors.md): Get-PropertyBehaviors - [Property build](https://techdocs.akamai.com/powershell/docs/get-propertybuild.md): Get-PropertyBuild - [Property certificate challenge](https://techdocs.akamai.com/powershell/docs/get-propertycertificatechallenge.md): Get-PropertyCertificateChallenge - [Property client settings](https://techdocs.akamai.com/powershell/docs/get-propertyclientsettings.md): Get-PropertyClientSettings - [Property contract](https://techdocs.akamai.com/powershell/docs/get-propertycontract.md): Get-PropertyContract - [Property criteria](https://techdocs.akamai.com/powershell/docs/get-propertycriteria.md): Get-PropertyCriteria - [Property hostname](https://techdocs.akamai.com/powershell/docs/get-propertyhostname.md): Get-PropertyHostname - [Product use cases](https://techdocs.akamai.com/powershell/docs/get-productusecases.md): Get-ProductUseCases - [Property request schema](https://techdocs.akamai.com/powershell/docs/get-propertyrequestschema.md): Get-PropertyRequestSchema - [Property rules](https://techdocs.akamai.com/powershell/docs/get-propertyrules.md): Get-PropertyRules - [Property rules digest](https://techdocs.akamai.com/powershell/docs/get-propertyrulesdigest.md): Get-PropertyRulesDigest - [Property version](https://techdocs.akamai.com/powershell/docs/get-propertyversion.md): Get-PropertyVersion - [Property version's includes](https://techdocs.akamai.com/powershell/docs/get-propertyversioninclude.md): Get-PropertyVersionInclude - [Rule format](https://techdocs.akamai.com/powershell/docs/get-ruleformat.md): Get-RuleFormat - [Rule format schema](https://techdocs.akamai.com/powershell/docs/get-ruleformatschema.md): Get-RuleFormatSchema - [Top-level groups](https://techdocs.akamai.com/powershell/docs/get-toplevelgroup.md): Get-TopLevelGroup - [Property rules](https://techdocs.akamai.com/powershell/docs/merge-propertyrules.md): Merge-PropertyRules - [Bulk activation](https://techdocs.akamai.com/powershell/docs/new-bulkactivation.md): New-BulkActivation - [Bulk patch](https://techdocs.akamai.com/powershell/docs/new-bulkpatch.md): New-BulkPatch - [Bulk search](https://techdocs.akamai.com/powershell/docs/new-bulksearch.md): New-BulkSearch - [Bulk version](https://techdocs.akamai.com/powershell/docs/new-bulkversion.md): New-BulkVersion - [CP code](https://techdocs.akamai.com/powershell/docs/new-cpcode.md): New-CPCode - [Edge hostname](https://techdocs.akamai.com/powershell/docs/new-edgehostname.md): New-EdgeHostname - [Include](https://techdocs.akamai.com/powershell/docs/new-propertyinclude.md): New-PropertyInclude - [Include activation](https://techdocs.akamai.com/powershell/docs/new-propertyincludeactivation.md): New-PropertyIncludeActivation - [Include deactivation](https://techdocs.akamai.com/powershell/docs/new-propertyincludedeactivation.md): New-PropertyIncludeDeactivation - [Include version](https://techdocs.akamai.com/powershell/docs/new-propertyincludeversion.md): New-PropertyIncludeVersion - [Property](https://techdocs.akamai.com/powershell/docs/new-property.md): New-Property - [Property activation](https://techdocs.akamai.com/powershell/docs/new-propertyactivation.md): New-PropertyActivation - [Property deactivation](https://techdocs.akamai.com/powershell/docs/new-propertydeactivation.md): New-PropertyDeactivation - [Property version](https://techdocs.akamai.com/powershell/docs/new-propertyversion.md): New-PropertyVersion - [Bucket hostname](https://techdocs.akamai.com/powershell/docs/remove-buckethostname.md): Remove-BucketHostname - [Include](https://techdocs.akamai.com/powershell/docs/remove-propertyinclude.md): Remove-PropertyInclude - [Include rule](https://techdocs.akamai.com/powershell/docs/remove-propertyincluderule.md): Remove-PropertyIncludeRule - [Property](https://techdocs.akamai.com/powershell/docs/remove-property.md): Remove-Property - [Property hostname](https://techdocs.akamai.com/powershell/docs/remove-propertyhostname.md): Remove-PropertyHostname - [Property rule](https://techdocs.akamai.com/powershell/docs/remove-propertyrule.md): Remove-PropertyRule - [Domain validation](https://techdocs.akamai.com/powershell/docs/resume-propertydomainvalidation.md): Resume-PropertyDomainValidation - [Client settings](https://techdocs.akamai.com/powershell/docs/set-propertyclientsettings.md): Set-PropertyClientSettings - [Include rules](https://techdocs.akamai.com/powershell/docs/set-propertyincluderules.md): Set-PropertyIncludeRules - [Property hostname](https://techdocs.akamai.com/powershell/docs/set-propertyhostname.md): Set-PropertyHostname - [Property rules](https://techdocs.akamai.com/powershell/docs/set-propertyrules.md): Set-PropertyRules - [Include](https://techdocs.akamai.com/powershell/docs/test-propertyinclude.md): Test-PropertyInclude - [Include rule](https://techdocs.akamai.com/powershell/docs/test-propertyincluderule.md) - [Property rule](https://techdocs.akamai.com/powershell/docs/test-propertyrule.md): Test-PropertyRule - [Bucket activation](https://techdocs.akamai.com/powershell/docs/undo-bucketactivation.md): Undo-BucketActivation - [Include activation](https://techdocs.akamai.com/powershell/docs/undo-propertyincludeactivation.md): Undo-PropertyIncludeActivation - [Property activation](https://techdocs.akamai.com/powershell/docs/undo-propertyactivation.md): Undo-PropertyActivation - [Domain validation](https://techdocs.akamai.com/powershell/docs/update-propertydomainvalidation.md): Update-PropertyDomainValidation - [Include rule](https://techdocs.akamai.com/powershell/docs/update-propertyincluderule.md): Update-PropertyIncludeRule - [Property rule](https://techdocs.akamai.com/powershell/docs/update-propertyrule.md): Update-PropertyRule - [Purge cache](https://techdocs.akamai.com/powershell/docs/purge.md) - [Function index](https://techdocs.akamai.com/powershell/docs/purge-index.md) - [Akamai cache](https://techdocs.akamai.com/powershell/docs/clear-akamaicache.md): Clear-AkamaiCache - [Get-PurgeLimit](https://techdocs.akamai.com/powershell/docs/get-purgelimit.md): Get-PurgeLimit - [Monitor performance](https://techdocs.akamai.com/powershell/docs/reports.md) - [Function index](https://techdocs.akamai.com/powershell/docs/reporting-index.md) - [Legacy report](https://techdocs.akamai.com/powershell/docs/get-legacyreport.md): Get-LegacyReport - [Legacy report type](https://techdocs.akamai.com/powershell/docs/get-legacyreporttype.md): Get-LegacyReportType - [Legacy report type versions](https://techdocs.akamai.com/powershell/docs/get-legacyreporttypeversions.md): Get-LegacyReportTypeVersions - [Product family](https://techdocs.akamai.com/powershell/docs/get-reportproductfamily.md): Get-ReportProductFamily - [Report](https://techdocs.akamai.com/powershell/docs/get-report.md): Get-Report - [Report type](https://techdocs.akamai.com/powershell/docs/get-reporttype.md): Get-ReportType - [Reporting area](https://techdocs.akamai.com/powershell/docs/get-reportingarea.md): Get-ReportingArea - [Legacy report](https://techdocs.akamai.com/powershell/docs/new-legacyreport.md): New-LegacyReport - [Report](https://techdocs.akamai.com/powershell/docs/new-report.md): New-Report - [Manage security events](https://techdocs.akamai.com/powershell/docs/siem.md) - [Function index](https://techdocs.akamai.com/powershell/docs/siem-index.md) - [SIEM event](https://techdocs.akamai.com/powershell/docs/format-siemevent.md): Format-SIEMEvent - [SIEM data](https://techdocs.akamai.com/powershell/docs/get-siemdata.md): Get-SIEMData - [Route traffic](https://techdocs.akamai.com/powershell/docs/siteshield.md) - [Function index](https://techdocs.akamai.com/powershell/docs/siteshield-index.md) - [Site shield map](https://techdocs.akamai.com/powershell/docs/confirm-siteshieldmap.md): Confirm-SiteShieldMap - [Site shield map](https://techdocs.akamai.com/powershell/docs/get-siteshieldmap.md): Get-SiteShieldMap - [Set up SLA test configurations](https://techdocs.akamai.com/powershell/docs/set-up-sla-test-configurations.md) - [Function index](https://techdocs.akamai.com/powershell/docs/sla-index.md) - [Availability report](https://techdocs.akamai.com/powershell/docs/get-slaavailabilityreport.md): Get-SLAAvailabilityReport - [Performance report](https://techdocs.akamai.com/powershell/docs/get-slaperformancereport.md): Get-SLAPerformanceReport - [Test agent group](https://techdocs.akamai.com/powershell/docs/get-slatestagentgroup.md): Get-SLATestAgentGroup - [Test configuration](https://techdocs.akamai.com/powershell/docs/get-slatestconfiguration.md): Get-SLATestConfiguration - [Test configuration quota](https://techdocs.akamai.com/powershell/docs/get-slatestconfigurationquota.md): Get-SLATestConfigurationQuota - [Test configuration](https://techdocs.akamai.com/powershell/docs/new-slatestconfiguration.md): New-SLATestConfiguration - [Test configuration](https://techdocs.akamai.com/powershell/docs/remove-slatestconfiguration.md): Remove-SLATestConfiguration - [Test configuration](https://techdocs.akamai.com/powershell/docs/set-slatestconfiguration.md): Set-SLATestConfiguration - [Manage tests](https://techdocs.akamai.com/powershell/docs/manage-tests.md) - [Function index](https://techdocs.akamai.com/powershell/docs/test-center-index.md) - [Test case](https://techdocs.akamai.com/powershell/docs/get-testcase.md): Get-TestCase - [Test catalog template](https://techdocs.akamai.com/powershell/docs/get-testcatalogtemplate.md): Get-TestCatalogTemplate - [Test condition](https://techdocs.akamai.com/powershell/docs/get-testcondition.md): Get-TestCondition - [Test request](https://techdocs.akamai.com/powershell/docs/get-testrequest.md): Get-TestRequest - [Test run](https://techdocs.akamai.com/powershell/docs/get-testrun.md): Get-TestRun - [Test run results](https://techdocs.akamai.com/powershell/docs/get-testrunresults.md): Get-TestRunResults - [Test suite](https://techdocs.akamai.com/powershell/docs/get-testsuite.md): Get-TestSuite - [Test variable](https://techdocs.akamai.com/powershell/docs/get-testvariable.md): Get-TestVariable - [Test suite](https://techdocs.akamai.com/powershell/docs/initialize-testsuite.md): Initialize-TestSuite - [Test case](https://techdocs.akamai.com/powershell/docs/new-testcase.md): New-TestCase - [Test suite](https://techdocs.akamai.com/powershell/docs/new-testsuite.md): New-TestSuite - [Test variable](https://techdocs.akamai.com/powershell/docs/new-testvariable.md): New-TestVariable - [Test case](https://techdocs.akamai.com/powershell/docs/remove-testcase.md): Remove-TestCase - [Test suite](https://techdocs.akamai.com/powershell/docs/remove-testsuite.md): Remove-TestSuite - [Test variable](https://techdocs.akamai.com/powershell/docs/remove-testvariable.md): Remove-TestVariable - [Test case](https://techdocs.akamai.com/powershell/docs/restore-testcase.md): Restore-TestCase - [Test suite](https://techdocs.akamai.com/powershell/docs/restore-testsuite.md): Restore-TestSuite - [Test case](https://techdocs.akamai.com/powershell/docs/set-testcase.md): Set-TestCase - [Test case order](https://techdocs.akamai.com/powershell/docs/set-testcaseorder.md): Set-TestCaseOrder - [Test suite](https://techdocs.akamai.com/powershell/docs/set-testsuite.md): Set-TestSuite - [Test variable](https://techdocs.akamai.com/powershell/docs/set-testvariable.md): Set-TestVariable - [Property version test](https://techdocs.akamai.com/powershell/docs/start-propertyversiontest.md): Start-PropertyVersionTest - [Test](https://techdocs.akamai.com/powershell/docs/start-test.md): Start-Test - [Test suite](https://techdocs.akamai.com/powershell/docs/start-testsuite.md): Start-TestSuite - [Test](https://techdocs.akamai.com/powershell/docs/test-testfunction.md): Test-TestFunction # Prolexic Analytics API Documentation > Akamai's Prolexic managed services help protect your network infrastructure against DDoS attacks. They include managed options available for your entire data center, as well as for individual internet-facing applications. Prolexic services help reduce the risk of DDoS attacks while maintaining the availability of Internet-facing applications. ## API Reference - [Prolexic Analytics API](https://techdocs.akamai.com/prolexic/reference/api.md) - [API summary](https://techdocs.akamai.com/prolexic/reference/api-summary.md) - [Get started](https://techdocs.akamai.com/prolexic/reference/api-get-started.md) - [API concepts](https://techdocs.akamai.com/prolexic/reference/api-concepts.md) - [Attack types](https://techdocs.akamai.com/prolexic/reference/attack-types.md) - [Data facet syntax](https://techdocs.akamai.com/prolexic/reference/data-facet-syntax.md) - [Rate limiting](https://techdocs.akamai.com/prolexic/reference/rate-limiting.md) - [Errors](https://techdocs.akamai.com/prolexic/reference/api-errors.md) - [400](https://techdocs.akamai.com/prolexic/reference/400.md) - [403](https://techdocs.akamai.com/prolexic/reference/403.md) - [404](https://techdocs.akamai.com/prolexic/reference/404.md) - [405](https://techdocs.akamai.com/prolexic/reference/405.md) - [410](https://techdocs.akamai.com/prolexic/reference/410.md) - [429](https://techdocs.akamai.com/prolexic/reference/429.md) - [500](https://techdocs.akamai.com/prolexic/reference/500.md) - [501](https://techdocs.akamai.com/prolexic/reference/501.md) - [503](https://techdocs.akamai.com/prolexic/reference/503.md) - [Get an attack report](https://techdocs.akamai.com/prolexic/reference/get-attack-report.md): Generates an attack report for the specified customer and `attackId`. - [List attack reports](https://techdocs.akamai.com/prolexic/reference/get-attack-reports.md): Retrieves a list of attack reports for a customer within the specified time range. - [List critical events](https://techdocs.akamai.com/prolexic/reference/get-critical-events-contract.md): Retrieves a critical events list for a customer. - [List events](https://techdocs.akamai.com/prolexic/reference/get-events-contract.md): Retrieves an events list for a customer. - [Get metrics data](https://techdocs.akamai.com/prolexic/reference/post-metrics.md): Lists metrics specified in the `type` object, between the given `start` and `end` times, sampled at the given rate and attached to given contract. Responses only contain data for valid requests. More meaningful errors result when requesting data for only one type at a time. - [List metric types](https://techdocs.akamai.com/prolexic/reference/get-metric-types-contract.md): Retrieve a list of metric types for a specific customer. - [Get active customer names](https://techdocs.akamai.com/prolexic/reference/get-customer-names.md): Retrieves contract and account details for customer names. - [List Routed tunnel routes](https://techdocs.akamai.com/prolexic/reference/post-routed-routes.md): Lists Routed 3.0 GRE and Routed 3.0 GRE over ADC tunnel routes data for all specified policy domains. Use the `prefix` in the response to match with the `bgp-sessions` response. - [Get time series data](https://techdocs.akamai.com/prolexic/reference/get-time-series-data.md): Lists usage and attack data for individual destination IP addresses. Optionally specify the `startTime` and `endTime` to get data from a specific period. The maximum date range is the last seven days, and by default you get data from the last two hours. Specify `locations` to include only traffic coming through specific data centers, or `source` for specific router types. Indicate the `samplingSize` to determine the number of timestamps to get data for. Enable `sum` to get aggregated data. - [Routed tunnel health](https://techdocs.akamai.com/prolexic/reference/post-routed-health.md): Lists total and healthy tunnel counts for Routed 3.0 GRE and Routed 3.0 GRE over ADC tunnels. Counts are per Akamai location and customer router combination for the unique pair of Akamai IP and remote IP. - [Routed tunnel BGP sessions](https://techdocs.akamai.com/prolexic/reference/post-routed-bgp-sessions.md): Lists BGP session information for Routed 3.0 GRE and Routed 3.0 GRE over ADC tunnels in all specified policy domains. Use the `customerBgpPeerIp4` or `customerBgpPeerIp6` from this response to match with `customerBgpPeerIp` and `prefix` based on the IP version in the routes response. The response includes `lastBgpResponseTimestamp` and `prefixesAdvertised` when available. - [List active scrubbing centers](https://techdocs.akamai.com/prolexic/reference/get-scrub-centers.md): Provides a list of all active scrub centers. ## Changelog - [New Routed 3.0 GRE funnel endpoints for Analytics API](https://techdocs.akamai.com/prolexic/changelog/new-routed-health-endpoints-for-analytics-api.md) - [Jan 4, 2022 — New Prolexic Analytics API documentation experience](https://techdocs.akamai.com/prolexic/changelog/jan-4-2022-new-prolexic-analytics-api-documentation-experience.md) # Prolexic IP Protect Configuration API Documentation > Akamai's Prolexic IP Protect API shields your site from DDoS attacks by diverting traffic and scrubbing network packets. ## API Reference - [Prolexic IP Protect Configuration API](https://techdocs.akamai.com/ip-protect/reference/api.md) - [API summary](https://techdocs.akamai.com/ip-protect/reference/api-summary.md) - [Get started](https://techdocs.akamai.com/ip-protect/reference/get-started.md) - [API concepts](https://techdocs.akamai.com/ip-protect/reference/api-concepts.md) - [Rate limits](https://techdocs.akamai.com/ip-protect/reference/rate-limits.md) - [Errors](https://techdocs.akamai.com/ip-protect/reference/errors.md) - [400](https://techdocs.akamai.com/ip-protect/reference/400.md) - [401](https://techdocs.akamai.com/ip-protect/reference/401.md) - [403](https://techdocs.akamai.com/ip-protect/reference/403.md) - [404](https://techdocs.akamai.com/ip-protect/reference/404.md) - [405](https://techdocs.akamai.com/ip-protect/reference/405.md) - [500](https://techdocs.akamai.com/ip-protect/reference/500.md) - [501](https://techdocs.akamai.com/ip-protect/reference/501.md) - [502](https://techdocs.akamai.com/ip-protect/reference/503.md) - [503](https://techdocs.akamai.com/ip-protect/reference/503-1.md) - [List mapped IP addresses](https://techdocs.akamai.com/ip-protect/reference/get-mips.md): Returns IP address ranges for the Akamai Management IP subnets. The Management IPs forward sanitized traffic from an Akamai scrubbing center to your network. - [List policy domains](https://techdocs.akamai.com/ip-protect/reference/get-policy-domains.md): Policy domain summary information including domain configurations and subnets. - [Get a policy domain](https://techdocs.akamai.com/ip-protect/reference/get-policy-domains-pdname.md): Returns summary information for the specified policy domain. Use the `extended` parameter to return information about the number of virtual IP addresses available to, and configured for, the domain. - [List virtual IP addresses](https://techdocs.akamai.com/ip-protect/reference/post-policy-domains-vips.md): Returns information about the specified virtual IP addresses. Include the IDs of those virtual IP addresses in the `vipIds` array in the request body. - [Get health status](https://techdocs.akamai.com/ip-protect/reference/post-policy-domains-vips-health-stats.md): Returns the health status for the specified policy domains in UNIX epoch milliseconds. Akamai retains health statistics for seven days. \nList domain names in the `customers` array in the request body. You can also use `startTime` and `endTime` to define a health status time interval, beginning with the `startTime` and ending with the `endTime`. If you don't include `endTime` the time interval automatically extends to the current time. - [Get health status for a policy domain](https://techdocs.akamai.com/ip-protect/reference/get-policy-domains-pdname-vips-health-stats.md): Returns the health status for the specified policy domain. Health status measures the percentage of locations currently availavle for a back-end IP address. IP Protect calculates separate health status scores for each back-end address. - [Create a new configuration version](https://techdocs.akamai.com/ip-protect/reference/post-policy-domains-pdname-configs.md): Adds new virtual IP addresses (VIPs) and creates or deletes subnets as needed for the specified policy domain. /nThe request body also requires the previously deployed configuration. Include the previous configuration's `pdSubnet`, `vips`, `vipId`, `customerBackend`, `akamaiFrontend`, `ports`, `sourceIpProtocol`, `probeType`, and `probePort` values to avoid the previous configuration being removed. To find the previous configuration, run [List policy configurations](ref:get-policy-domains-pdname-configs). - [List policy configurations](https://techdocs.akamai.com/ip-protect/reference/get-policy-domains-pdname-configs.md): Returns configuration information for the specified policy domain. By default, this operation returns all the available configuration sets. Use the `latest` parameter to return only the most recent set of configuration values. - [Update domain to allocate subnets](https://techdocs.akamai.com/ip-protect/reference/put-policy-domains-pdname-pd-subnets-allocate.md): Adds virtual IP addresses to the specified policy domain. In the request body, use `addVips` to specify the number of virtual IP addresses you're adding, and use `allocateIpv6` to configure the IP addressing type for these addresses. Set `allocateIpv6` to `true` to use IPv6 addressing, and either omit `allocateIpv6` or set the value to `false` to use IPv4 addressing. ## Changelog - [Jan 5, 2022 — New IP Protect API documentation experience](https://techdocs.akamai.com/ip-protect/changelog/jan-5-2022-new-ip-protect-api-documentation-experience.md) # Property Manager Documentation > Property Manager is a configuration tool that you use with other Akamai products to start serving the traffic to your site or application through the Akamai edge network. ## Guides - [Welcome to Property Manager](https://techdocs.akamai.com/property-mgr/docs/welcome-prop-manager.md) - [Key concepts and terms](https://techdocs.akamai.com/property-mgr/docs/key-concepts-terms.md) - [Workflow overview](https://techdocs.akamai.com/property-mgr/docs/workflow-ov.md) - [Know your way around](https://techdocs.akamai.com/property-mgr/docs/know-your-around.md) - [Get to know the request flow](https://techdocs.akamai.com/property-mgr/docs/understand-the-request-flow.md) - [Prepare your edge certificates](https://techdocs.akamai.com/property-mgr/docs/prepare-your-edge-certificates.md) - [Prepare your origin server](https://techdocs.akamai.com/property-mgr/docs/prepare-your-origin-server.md) - [NetStorage origin prerequisites](https://techdocs.akamai.com/property-mgr/docs/netstorage-origin-prerequisites.md) - [Custom origin prerequisites](https://techdocs.akamai.com/property-mgr/docs/custom-origin-prerequisites.md) - [Third-party origin prerequisites](https://techdocs.akamai.com/property-mgr/docs/third-party-origin-prerequisites.md) - [Create a brand-new property](https://techdocs.akamai.com/property-mgr/docs/create-new-prop.md) - [Clone a property](https://techdocs.akamai.com/property-mgr/docs/clone-prop.md) - [Map your domain to a property](https://techdocs.akamai.com/property-mgr/docs/redirect-users-edge-servers.md) - [Configure HTTPS hostnames](https://techdocs.akamai.com/property-mgr/docs/serve-content-over-https.md) - [Add a hostname with a CPS-managed certificate](https://techdocs.akamai.com/property-mgr/docs/add-hn-custom-cert.md) - [Add a hostname with a Default DV certificate](https://techdocs.akamai.com/property-mgr/docs/add-hn-with-default-cert.md) - [Default DV contract limit and usage](https://techdocs.akamai.com/property-mgr/docs/default-dv-contract-limit-and-usage.md) - [Akamai-managed TLS Profile](https://techdocs.akamai.com/property-mgr/docs/akamai-managed-tls-profile.md) - [Add a hostname with a CCM certificate (Limited Availability)](https://techdocs.akamai.com/property-mgr/docs/add-a-hostname-with-a-ccm-certificate.md) - [Use the Akamai shared certificate](https://techdocs.akamai.com/property-mgr/docs/use-akamai-shared-cert.md) - [Move a secure hostname to a different network](https://techdocs.akamai.com/property-mgr/docs/move-secure-hn-to-a-diff-net.md) - [Remove a secure hostname from a property (LA)](https://techdocs.akamai.com/property-mgr/docs/rm-secure-hn-prop-la.md) - [Upgrade an HTTP hostname to HTTPS](https://techdocs.akamai.com/property-mgr/docs/upgrade-existing-http-prop-standard-tls.md) - [Migrate from an earlier version of Standard TLS](https://techdocs.akamai.com/property-mgr/docs/migrate-earlier-version-standard-tls.md) - [Restart a Default DV certificate validation](https://techdocs.akamai.com/property-mgr/docs/re-launch-a-default-certificate-validation-ui.md) - [Configure hostnames in a bucket](https://techdocs.akamai.com/property-mgr/docs/configure-hostname-buckets.md) - [Add hostnames with Default DV certificates to the bucket (Limited Availability)](https://techdocs.akamai.com/property-mgr/docs/add-hostnames-with-default-certificates-bucket.md) - [Add hostnames with custom certificates to the bucket](https://techdocs.akamai.com/property-mgr/docs/add-hostnames-with-custom-certificates-to-the-bucket.md) - [Remove hostnames from the bucket](https://techdocs.akamai.com/property-mgr/docs/remove-hostnames-from-the-bucket.md) - [Configure HTTP hostnames (legacy)](https://techdocs.akamai.com/property-mgr/docs/serve-content-over-http.md) - [Prove domain ownership](https://techdocs.akamai.com/property-mgr/docs/prove-domain-ownership.md) - [Edit HTTPS/HTTP hostname settings](https://techdocs.akamai.com/property-mgr/docs/edit-existing-hn-settings.md) - [Edge IP Binding](https://techdocs.akamai.com/property-mgr/docs/what-edge-ip-binding.md) - [HTTPS Service Binding](https://techdocs.akamai.com/property-mgr/docs/https-service-binding.md) - [Configure Media Delivery Type](https://techdocs.akamai.com/property-mgr/docs/what-use-case-based-edge-mapping.md) - [Optional: slot support](https://techdocs.akamai.com/property-mgr/docs/opt-slot-support.md) - [Variables overview](https://techdocs.akamai.com/property-mgr/docs/var-ov.md) - [User-defined variables](https://techdocs.akamai.com/property-mgr/docs/user-defined-vars.md) - [Built-in variables](https://techdocs.akamai.com/property-mgr/docs/built-vars.md) - [Use variables in a behavior](https://techdocs.akamai.com/property-mgr/docs/use-vars-beh.md) - [Match on a variable](https://techdocs.akamai.com/property-mgr/docs/match-var.md) - [Match on variable errors](https://techdocs.akamai.com/property-mgr/docs/match-var-err.md) - [Test configurations with variables](https://techdocs.akamai.com/property-mgr/docs/test-configs-vars.md) - [Set Variable behavior](https://techdocs.akamai.com/property-mgr/docs/set-var-beh.md) - [Set Variable: extraction](https://techdocs.akamai.com/property-mgr/docs/set-var-extraction.md) - [Set Variable: generation](https://techdocs.akamai.com/property-mgr/docs/set-var-generation.md) - [Set Variable: expression](https://techdocs.akamai.com/property-mgr/docs/set-var-exp.md) - [Set Variable: operations](https://techdocs.akamai.com/property-mgr/docs/set-var-op.md) - [Property Configuration logic](https://techdocs.akamai.com/property-mgr/docs/config-best-practices.md) - [Add your origin server](https://techdocs.akamai.com/property-mgr/docs/add-an-origin-server-to-your-property.md) - [The NetStorage origin server](https://techdocs.akamai.com/property-mgr/docs/the-netstorage-origin-server.md) - [The custom origin (publicly trusted certificate)](https://techdocs.akamai.com/property-mgr/docs/the-custom-origin-public.md) - [The custom origin (pinned certificate)](https://techdocs.akamai.com/property-mgr/docs/the-custom-origin-pinned.md) - [The third-party origin](https://techdocs.akamai.com/property-mgr/docs/the-third-party-origin.md) - [The SaaS dynamic origin](https://techdocs.akamai.com/property-mgr/docs/saas-dynamic-origin.md) - [Learn about Akamai's caching](https://techdocs.akamai.com/property-mgr/docs/know-caching.md) - [Learn about Cloudlets](https://techdocs.akamai.com/property-mgr/docs/know-cloudlets.md) - [Includes](https://techdocs.akamai.com/property-mgr/docs/includes-overview.md) - [Create a brand new include](https://techdocs.akamai.com/property-mgr/docs/create-new-include.md) - [Clone an include](https://techdocs.akamai.com/property-mgr/docs/clone-include.md) - [Edit an include](https://techdocs.akamai.com/property-mgr/docs/edit-include.md) - [Activate an include](https://techdocs.akamai.com/property-mgr/docs/activate-include.md) - [Add an include to a property](https://techdocs.akamai.com/property-mgr/docs/add-include-to-property.md) - [Rules](https://techdocs.akamai.com/property-mgr/docs/rules.md) - [Add rules](https://techdocs.akamai.com/property-mgr/docs/add-rules.md) - [Custom override rule](https://techdocs.akamai.com/property-mgr/docs/custom-override-rule.md) - [Manage rules](https://techdocs.akamai.com/property-mgr/docs/manage-rules.md) - [Rule formats](https://techdocs.akamai.com/property-mgr/docs/rule-format-versions.md) - [Matches](https://techdocs.akamai.com/property-mgr/docs/matches.md) - [Advanced Match](https://techdocs.akamai.com/property-mgr/docs/adv-match.md) - [Akamai Server Location](https://techdocs.akamai.com/property-mgr/docs/akamai-server-location.md) - [CDN Network](https://techdocs.akamai.com/property-mgr/docs/cdn-network.md) - [ChinaCDN Region](https://techdocs.akamai.com/property-mgr/docs/chinacdn-region.md) - [Client certificate](https://techdocs.akamai.com/property-mgr/docs/client-cert.md) - [Client IP](https://techdocs.akamai.com/property-mgr/docs/client-ip.md) - [Client IP Version](https://techdocs.akamai.com/property-mgr/docs/client-ip-version.md) - [Conditional Origin ID](https://techdocs.akamai.com/property-mgr/docs/conditional-origin-id.md) - [Content Provider Code](https://techdocs.akamai.com/property-mgr/docs/content-provider-code-match.md) - [Content Type](https://techdocs.akamai.com/property-mgr/docs/content-type.md) - [Debug Mode](https://techdocs.akamai.com/property-mgr/docs/debug-mode.md) - [Device Characteristics](https://techdocs.akamai.com/property-mgr/docs/device-charac.md) - [EdgeWorkers Execution Status](https://techdocs.akamai.com/property-mgr/docs/edge-workers-failure.md) - [File Extension](https://techdocs.akamai.com/property-mgr/docs/file-ext.md) - [Filename](https://techdocs.akamai.com/property-mgr/docs/filename-match.md) - [Hostname](https://techdocs.akamai.com/property-mgr/docs/hn.md) - [Image and Video Manager](https://techdocs.akamai.com/property-mgr/docs/img-video-manager.md) - [Metadata Stage](https://techdocs.akamai.com/property-mgr/docs/metadata-stage.md) - [Origin Timeout](https://techdocs.akamai.com/property-mgr/docs/origin-timeout.md) - [Path](https://techdocs.akamai.com/property-mgr/docs/path-match.md) - [Percentage of Clients](https://techdocs.akamai.com/property-mgr/docs/percentage-clients.md) - [Query String Parameter](https://techdocs.akamai.com/property-mgr/docs/query-string-param.md) - [Recovery Configuration Name](https://techdocs.akamai.com/property-mgr/docs/recovery-config-name.md) - [Regex](https://techdocs.akamai.com/property-mgr/docs/regex.md) - [Response Cacheability](https://techdocs.akamai.com/property-mgr/docs/response-cacheability.md) - [Response Header](https://techdocs.akamai.com/property-mgr/docs/response-header.md) - [Response Status Code](https://techdocs.akamai.com/property-mgr/docs/response-status-cookie.md) - [Request Cookie](https://techdocs.akamai.com/property-mgr/docs/req-cookie.md) - [Request Header](https://techdocs.akamai.com/property-mgr/docs/req-header.md) - [Request Method](https://techdocs.akamai.com/property-mgr/docs/req-method.md) - [Request Protocol](https://techdocs.akamai.com/property-mgr/docs/req-protocol.md) - [Request Type](https://techdocs.akamai.com/property-mgr/docs/req-type.md) - [Sample Percentage](https://techdocs.akamai.com/property-mgr/docs/sample-percentage.md) - [Time Interval](https://techdocs.akamai.com/property-mgr/docs/time-interval.md) - [Token Verification Result](https://techdocs.akamai.com/property-mgr/docs/token-ver-result.md) - [User Agent](https://techdocs.akamai.com/property-mgr/docs/user-agent.md) - [User Location Data](https://techdocs.akamai.com/property-mgr/docs/user-loc-data.md) - [User Network Data](https://techdocs.akamai.com/property-mgr/docs/user-network-data.md) - [Variable](https://techdocs.akamai.com/property-mgr/docs/var.md) - [Variable Error](https://techdocs.akamai.com/property-mgr/docs/var-err.md) - [Behaviors](https://techdocs.akamai.com/property-mgr/docs/behs.md) - [Ad Scaler Circuit Breaker](https://techdocs.akamai.com/property-mgr/docs/ad-scaler-circuit-breaker.md) - [Adaptive Acceleration](https://techdocs.akamai.com/property-mgr/docs/adaptive-accel.md) - [Adaptive Image Compression](https://techdocs.akamai.com/property-mgr/docs/adaptive-img-comp-aic.md) - [Advanced](https://techdocs.akamai.com/property-mgr/docs/adv-beh.md) - [Aggregated Reporting](https://techdocs.akamai.com/property-mgr/docs/aggd-rpt.md) - [Akamai API Gateway](https://techdocs.akamai.com/property-mgr/docs/akamai-api-gateway.md) - [Akamai Connector for Salesforce Commerce Cloud](https://techdocs.akamai.com/property-mgr/docs/akamai-conn-salesforce-commerce-cloud.md) - [Akamai Instant](https://techdocs.akamai.com/property-mgr/docs/akamai-instant.md) - [Akamai Mobile Protocol](https://techdocs.akamai.com/property-mgr/docs/akamai-mobile-protocol.md) - [Akamai Provider for Salesforce Commerce Cloud](https://techdocs.akamai.com/property-mgr/docs/akamai-provider-salesforce-commerce-cloud.md) - [Akamai Provider for Salesforce Commerce Cloud Host Header Control](https://techdocs.akamai.com/property-mgr/docs/akamai-provider-salesforce-commerce-cloud-host-header-control.md) - [Akamaize Tag](https://techdocs.akamai.com/property-mgr/docs/akamaize-tag.md) - [Akamaizer](https://techdocs.akamai.com/property-mgr/docs/akamaizer.md) - [Allow All Methods on Parent Servers](https://techdocs.akamai.com/property-mgr/docs/allow-methods-parent-servers.md) - [Allow Caching on Commercial Network](https://techdocs.akamai.com/property-mgr/docs/allow-caching-on-commercial-network.md) - [Allow Conditional Origins](https://techdocs.akamai.com/property-mgr/docs/conditional-origins.md) - [Allow DELETE](https://techdocs.akamai.com/property-mgr/docs/allow-delete.md) - [Allow OPTIONS](https://techdocs.akamai.com/property-mgr/docs/allow-options.md) - [allow-patch](https://techdocs.akamai.com/property-mgr/docs/allow-patch.md) - [Allow POST](https://techdocs.akamai.com/property-mgr/docs/allow-post.md) - [Allow PUT](https://techdocs.akamai.com/property-mgr/docs/allow-put.md) - [Alt-Svc Header](https://techdocs.akamai.com/property-mgr/docs/alt-svc-header.md) - [API Prioritization Cloudlet](https://techdocs.akamai.com/property-mgr/docs/api-prioritization-cloudlet.md) - [Application Load Balancer Cloudlet](https://techdocs.akamai.com/property-mgr/docs/app-load-balancer-cloudlet.md) - [Audience Segmentation Cloudlet](https://techdocs.akamai.com/property-mgr/docs/audience-segmentation-cloudlet.md) - [Auth Token 2.0 Verification](https://techdocs.akamai.com/property-mgr/docs/auth-token-2-0-ver.md) - [Auto Domain Validation](https://techdocs.akamai.com/property-mgr/docs/auto-domain-val.md) - [Bit Rate Limiting](https://techdocs.akamai.com/property-mgr/docs/bit-rate-limiting.md) - [Breadcrumbs](https://techdocs.akamai.com/property-mgr/docs/breadcrumbs-amd.md) - [Break Forward Connection](https://techdocs.akamai.com/property-mgr/docs/break-forward-connection.md) - [Brotli Support](https://techdocs.akamai.com/property-mgr/docs/brotli-support.md) - [Cache HTTP Error Responses](https://techdocs.akamai.com/property-mgr/docs/cache-http-err-responses.md) - [Cache HTTP Temporary Redirects](https://techdocs.akamai.com/property-mgr/docs/cache-http-redirects.md) - [Cache ID Modification](https://techdocs.akamai.com/property-mgr/docs/cache-id-modification.md) - [Cache Key Path Rewrite](https://techdocs.akamai.com/property-mgr/docs/cache-key-path-rewrite.md) - [Cache Key Query Parameters](https://techdocs.akamai.com/property-mgr/docs/cache-key-query-param.md) - [Cache POST Responses](https://techdocs.akamai.com/property-mgr/docs/cache-post-responses.md) - [Cache Prefreshing](https://techdocs.akamai.com/property-mgr/docs/cache-prefresh-refresh.md) - [Cache Tag](https://techdocs.akamai.com/property-mgr/docs/cache-tag.md) - [Cache Tag Visibility](https://techdocs.akamai.com/property-mgr/docs/cache-tag-visibility.md) - [Caching](https://techdocs.akamai.com/property-mgr/docs/caching-2.md) - [Centralized Authorization](https://techdocs.akamai.com/property-mgr/docs/centralized-authz.md) - [Chase Redirects](https://techdocs.akamai.com/property-mgr/docs/chase-redirects.md) - [Chunked Transfer Encoding](https://techdocs.akamai.com/property-mgr/docs/chunked-transfer-encoding.md) - [Client Certificate Authentication](https://techdocs.akamai.com/property-mgr/docs/client-certificate-authentication.md) - [Client Characteristics](https://techdocs.akamai.com/property-mgr/docs/client-charac.md) - [Cloud Interconnects for Microsoft Azure](https://techdocs.akamai.com/property-mgr/docs/cloud-interconnects-azure.md) - [Cloud Interconnects for Google Cloud](https://techdocs.akamai.com/property-mgr/docs/cloud-interconnects-google-cloud-gcp.md) - [Cloud Monitor Data Delivery](https://techdocs.akamai.com/property-mgr/docs/cloud-monitor-data-deliv.md) - [Cloud Monitor Instrumentation](https://techdocs.akamai.com/property-mgr/docs/cloud-monitor-instrumentation.md) - [Cloud Wrapper](https://techdocs.akamai.com/property-mgr/docs/cloud-wrapper.md) - [Cloud Wrapper Advanced](https://techdocs.akamai.com/property-mgr/docs/cloud-wrapper-adv.md) - [Common Media Client Data support](https://techdocs.akamai.com/property-mgr/docs/common-media-client-data-support.md) - [Connect Timeout](https://techdocs.akamai.com/property-mgr/docs/connect-timeout.md) - [Construct Response](https://techdocs.akamai.com/property-mgr/docs/construct-response.md) - [Content Characteristics](https://techdocs.akamai.com/property-mgr/docs/content-charac.md) - [Content Characteristics - Dynamic Web Content](https://techdocs.akamai.com/property-mgr/docs/content-charac-dynamic-web-content.md) - [Content Characteristics - Large File](https://techdocs.akamai.com/property-mgr/docs/content-charac-large-file.md) - [Content Characteristics - Streaming Video Live](https://techdocs.akamai.com/property-mgr/docs/content-charact-streaming-video-live.md) - [Content Characteristics - Streaming Video On-demand](https://techdocs.akamai.com/property-mgr/docs/content-charac-streaming-video-on-demand.md) - [Content Provider Code](https://techdocs.akamai.com/property-mgr/docs/content-provider-code-beh.md) - [Content Targeting (EdgeScape)](https://techdocs.akamai.com/property-mgr/docs/content-tgting.md) - [Content Targeting - Protection](https://techdocs.akamai.com/property-mgr/docs/content-tgting-prot-amd.md) - [Control Access](https://techdocs.akamai.com/property-mgr/docs/control-access.md) - [Cookie Authorization](https://techdocs.akamai.com/property-mgr/docs/cookie-authz.md) - [CORS Protocol Support](https://techdocs.akamai.com/property-mgr/docs/cors-protocol-support.md) - [Custom Behavior](https://techdocs.akamai.com/property-mgr/docs/custom-behavior.md) - [DataStream](https://techdocs.akamai.com/property-mgr/docs/datastream-beh.md) - [Device Characterization - Define Cached Content](https://techdocs.akamai.com/property-mgr/docs/device-characterization-dc.md) - [Device Characterization - Forward in Header](https://techdocs.akamai.com/property-mgr/docs/device-characterization-forward-in-header.md) - [Diagnostic Data Beacons](https://techdocs.akamai.com/property-mgr/docs/diagnostic-data-beacons.md) - [DNS Asynchronous Prefresh](https://techdocs.akamai.com/property-mgr/docs/dns-asynchronous-prefresh.md) - [DNS Asynchronous Refresh](https://techdocs.akamai.com/property-mgr/docs/dns-asynchronous-refresh.md) - [Download Complete Marker](https://techdocs.akamai.com/property-mgr/docs/dl-complete-marker.md) - [Download Notification](https://techdocs.akamai.com/property-mgr/docs/dl-notif.md) - [Downstream Cacheability](https://techdocs.akamai.com/property-mgr/docs/downstream-cacheability.md) - [Dynamic Page Caching](https://techdocs.akamai.com/property-mgr/docs/dynamic-page-caching.md) - [Early Data (0-RTT)](https://techdocs.akamai.com/property-mgr/docs/early-data-0rtt.md) - [Early Data (0-RTT) Advanced](https://techdocs.akamai.com/property-mgr/docs/early-data-0rtt-advanced.md) - [Early Hints](https://techdocs.akamai.com/property-mgr/docs/early-hints.md) - [Edge Load Balancing: Advanced Metadata](https://techdocs.akamai.com/property-mgr/docs/edge-load-balancing.md) - [Edge Load Balancing: Data Center](https://techdocs.akamai.com/property-mgr/docs/edge-load-balancing-data-center.md) - [Edge Load Balancing: Origin Definition](https://techdocs.akamai.com/property-mgr/docs/edge-load-balancing-origin-definition.md) - [Edge Redirector Cloudlet](https://techdocs.akamai.com/property-mgr/docs/edge-redirector-cloudlet.md) - [Edge Server Identification](https://techdocs.akamai.com/property-mgr/docs/edge-server-identification.md) - [EdgeWorkers](https://techdocs.akamai.com/property-mgr/docs/edgeworkers-beh.md) - [Enforce mTLS settings](https://techdocs.akamai.com/property-mgr/docs/enforce-mtls-settings.md) - [Enhanced Debug](https://techdocs.akamai.com/property-mgr/docs/enhanced-debug.md) - [Enhanced Akamai Protocol](https://techdocs.akamai.com/property-mgr/docs/enhanced-akamai-protocol.md) - [Enhanced Proxy Detection with GeoGuard](https://techdocs.akamai.com/property-mgr/docs/enhanced-proxy-detn-geoguard.md) - [ESI (Edge Side Includes)](https://techdocs.akamai.com/property-mgr/docs/esi-edge-side-includes.md) - [Fast Invalidate](https://techdocs.akamai.com/property-mgr/docs/fast-inval.md) - [FIPS mode - origin](https://techdocs.akamai.com/property-mgr/docs/fips-mode-origin.md) - [Forward Header Enrichment](https://techdocs.akamai.com/property-mgr/docs/forward-header-enrichment.md) - [Forward Rewrite Cloudlet](https://techdocs.akamai.com/property-mgr/docs/forward-rewrite-cloudlet.md) - [Global Request Number](https://techdocs.akamai.com/property-mgr/docs/global-req-number.md) - [Google Tag Gateway](https://techdocs.akamai.com/property-mgr/docs/google-tag-gateway.md) - [GraphQL Caching](https://techdocs.akamai.com/property-mgr/docs/graphql-caching.md) - [gRPC (Beta)](https://techdocs.akamai.com/property-mgr/docs/google-rpc.md) - [HD Data Override: Advanced Metadata](https://techdocs.akamai.com/property-mgr/docs/hd-data-override-advanced-metadata.md) - [HSAF for Edge IP Binding](https://techdocs.akamai.com/property-mgr/docs/hsaf-edge-ip-binding.md) - [HTTP Strict Transport Security (HSTS)](https://techdocs.akamai.com/property-mgr/docs/http-strict-transport-security-hsts.md) - [HTTP to HTTPS Upgrade](https://techdocs.akamai.com/property-mgr/docs/http-https-upgrade.md) - [HTTP/2](https://techdocs.akamai.com/property-mgr/docs/http2-support.md) - [HTTP/3](https://techdocs.akamai.com/property-mgr/docs/http3-support.md) - [HTTPS Cache Key Sharing](https://techdocs.akamai.com/property-mgr/docs/https-cache-key-sharing.md) - [IBM Tealeaf Connector](https://techdocs.akamai.com/property-mgr/docs/ibm-tealeaf-conn.md) - [Ignore Case In Cache Key](https://techdocs.akamai.com/property-mgr/docs/ignore-case-cache-key.md) - [Image and Video Manager (Images)](https://techdocs.akamai.com/property-mgr/docs/img-video-manager-img.md) - [Image and Video Manager (Videos)](https://techdocs.akamai.com/property-mgr/docs/img-video-manager-videos.md) - [Image and Video Manager: Set Parameter](https://techdocs.akamai.com/property-mgr/docs/img-video-manager-set-param.md) - [Image Converter Settings](https://techdocs.akamai.com/property-mgr/docs/img-converter-settings.md) - [Inject Reference ID](https://techdocs.akamai.com/property-mgr/docs/inject-reference-id.md) - [InstantConfig](https://techdocs.akamai.com/property-mgr/docs/instantconfig-beh.md) - [Large File Optimization](https://techdocs.akamai.com/property-mgr/docs/large-file-optimization-lfo.md) - [Large File Optimization Advanced](https://techdocs.akamai.com/property-mgr/docs/large-file-optimization-advanced.md) - [Last Mile Acceleration](https://techdocs.akamai.com/property-mgr/docs/last-mile-accel-gzip-comp.md) - [Legacy Referrer Checking](https://techdocs.akamai.com/property-mgr/docs/legacy-referrer-checking.md) - [Localhost Loopback Protection](https://techdocs.akamai.com/property-mgr/docs/localhost-loopback-protection.md) - [Log Custom Details](https://techdocs.akamai.com/property-mgr/docs/log-custom-details.md) - [Log Request Details](https://techdocs.akamai.com/property-mgr/docs/log-req-details.md) - [Manifest Personalization](https://techdocs.akamai.com/property-mgr/docs/manifest-personalization-amd.md) - [Manifest Rerouting](https://techdocs.akamai.com/property-mgr/docs/manifest-rerouting.md) - [Manual Preconnect](https://techdocs.akamai.com/property-mgr/docs/manual-preconnect.md) - [Manual Server Push](https://techdocs.akamai.com/property-mgr/docs/manual-server-push.md) - [Media Acceleration](https://techdocs.akamai.com/property-mgr/docs/media-accel.md) - [Media Acceleration (QUIC Protocol) Opt-Out](https://techdocs.akamai.com/property-mgr/docs/media-accel-quic-protocol-opt-out.md) - [Media Client](https://techdocs.akamai.com/property-mgr/docs/media-client.md) - [Media File Retrieval Optimization](https://techdocs.akamai.com/property-mgr/docs/media-file-retrieval-optimization.md) - [Media Origin Failover](https://techdocs.akamai.com/property-mgr/docs/media-origin-failover.md) - [Metadata Caching](https://techdocs.akamai.com/property-mgr/docs/metadata-caching.md) - [Mobile App Performance SDK](https://techdocs.akamai.com/property-mgr/docs/mobile-app-perf-sdk.md) - [Mobile Detection and Redirect](https://techdocs.akamai.com/property-mgr/docs/mobile-detn-redirect.md) - [Modify Incoming Request Header](https://techdocs.akamai.com/property-mgr/docs/modify-incoming-req-header.md) - [Modify Incoming Response Header](https://techdocs.akamai.com/property-mgr/docs/modify-incoming-response-header.md) - [Modify Outgoing Request Header](https://techdocs.akamai.com/property-mgr/docs/modify-outgoing-req-header.md) - [Modify Outgoing Request Path](https://techdocs.akamai.com/property-mgr/docs/modify-outgoing-req-path.md) - [Modify Outgoing Response Header](https://techdocs.akamai.com/property-mgr/docs/modify-outgoing-response-header.md) - [Modify Via Header](https://techdocs.akamai.com/property-mgr/docs/modify-via-header.md) - [mPulse](https://techdocs.akamai.com/property-mgr/docs/mpulse-beh.md) - [mTLS Edge Server to Origin](https://techdocs.akamai.com/property-mgr/docs/mtls-origin-keystore.md) - [Network Conditions Header](https://techdocs.akamai.com/property-mgr/docs/network-conditions-header.md) - [Object Caching](https://techdocs.akamai.com/property-mgr/docs/object-caching-od.md) - [Optimize Text Streaming (Beta)](https://techdocs.akamai.com/property-mgr/docs/optimize-text-streaming.md) - [Origin Base Path](https://techdocs.akamai.com/property-mgr/docs/origin-base-path.md) - [Origin Characteristics](https://techdocs.akamai.com/property-mgr/docs/origin-charac.md) - [Origin Failure Recovery Method](https://techdocs.akamai.com/property-mgr/docs/origin-failure-recovery-method.md) - [Origin Failure Recovery Policy](https://techdocs.akamai.com/property-mgr/docs/origin-failure-recovery-policy.md) - [Origin Health Detection](https://techdocs.akamai.com/property-mgr/docs/origin-health-detect.md) - [Origin IP Access Control List](https://techdocs.akamai.com/property-mgr/docs/origin-ip-access-control.md) - [Origin Server](https://techdocs.akamai.com/property-mgr/docs/origin-server.md) - [Permissions-Policy](https://techdocs.akamai.com/property-mgr/docs/permissions-policy.md) - [Persistent Connections: Client to Edge](https://techdocs.akamai.com/property-mgr/docs/persistent-connections-client-to-edge.md) - [Persistent Connections: Edge to Origin](https://techdocs.akamai.com/property-mgr/docs/persistent-connections-edge-to-origin.md) - [Personally Identifiable Information](https://techdocs.akamai.com/property-mgr/docs/personally-identifiable-info-pii.md) - [Phased Release Cloudlet](https://techdocs.akamai.com/property-mgr/docs/phased-release-cloudlet.md) - [Post Quantum Cryptography (PQC) Client to Edge](https://techdocs.akamai.com/property-mgr/docs/pqc-client-to-edge.md) - [Post Quantum Cryptography (PQC) to Origin](https://techdocs.akamai.com/property-mgr/docs/pqc-origin.md) - [Predictive Content Delivery](https://techdocs.akamai.com/property-mgr/docs/predictive-content-delivery.md) - [Predictive Prefetching](https://techdocs.akamai.com/property-mgr/docs/predictive-prefetching.md) - [Prefetch Objects](https://techdocs.akamai.com/property-mgr/docs/prefetching.md) - [Prefetchable Objects](https://techdocs.akamai.com/property-mgr/docs/prefetchable-objects.md) - [Protocol Downgrade (HTTPS Downgrade to Origin)](https://techdocs.akamai.com/property-mgr/docs/protocol-downgrade-https-downgrade-origin.md) - [Protocol Downgrade (Legacy)](https://techdocs.akamai.com/property-mgr/docs/protocol-downgrade-legacy.md) - [Query Authorization](https://techdocs.akamai.com/property-mgr/docs/query-authz.md) - [QUIC Support](https://techdocs.akamai.com/property-mgr/docs/quic-support.md) - [Quick Retry](https://techdocs.akamai.com/property-mgr/docs/quick-retry.md) - [Random Seek](https://techdocs.akamai.com/property-mgr/docs/random-seek.md) - [Read Timeout](https://techdocs.akamai.com/property-mgr/docs/read-timeout.md) - [Real-time Reporting](https://techdocs.akamai.com/property-mgr/docs/rt-rpt.md) - [Redirect](https://techdocs.akamai.com/property-mgr/docs/redirect-beh.md) - [Redirect Plus](https://techdocs.akamai.com/property-mgr/docs/redirect-plus.md) - [Referrer Checking](https://techdocs.akamai.com/property-mgr/docs/referrer-checking.md) - [Remove Outgoing Request Parameters](https://techdocs.akamai.com/property-mgr/docs/rm-outgoing-req-param.md) - [Remove Vary Header](https://techdocs.akamai.com/property-mgr/docs/rm-vary-header.md) - [Request Client Hints](https://techdocs.akamai.com/property-mgr/docs/request-client-hints.md) - [Request Control Cloudlet](https://techdocs.akamai.com/property-mgr/docs/req-control-cloudlet.md) - [Request Type Marker](https://techdocs.akamai.com/property-mgr/docs/req-type-marker.md) - [Resource Optimizer Extended Compatibility](https://techdocs.akamai.com/property-mgr/docs/resource-optimizer-extended-compat.md) - [Return Cache Status](https://techdocs.akamai.com/property-mgr/docs/return-cache-status.md) - [RMA Optimizations](https://techdocs.akamai.com/property-mgr/docs/rma-optimizations.md) - [Save POST DCA processing result](https://techdocs.akamai.com/property-mgr/docs/save-post-dca-processing-result.md) - [Scheduled Invalidation](https://techdocs.akamai.com/property-mgr/docs/scheduled-inval.md) - [Script Management](https://techdocs.akamai.com/property-mgr/docs/script-mgmt.md) - [Security Failover Protection](https://techdocs.akamai.com/property-mgr/docs/security-failover-prot.md) - [Segmented Media Delivery Mode](https://techdocs.akamai.com/property-mgr/docs/segmented-media-deliv-mode.md) - [Segmented Media Protection](https://techdocs.akamai.com/property-mgr/docs/segmented-media-prot-amd.md) - [Segmented Media Streaming - Prefetch](https://techdocs.akamai.com/property-mgr/docs/segmented-media-streaming-prefetch-amd.md) - [Set Response Code](https://techdocs.akamai.com/property-mgr/docs/set-response-code.md) - [Set Response Cookie](https://techdocs.akamai.com/property-mgr/docs/set-response-cookie.md) - [SHUTR](https://techdocs.akamai.com/property-mgr/docs/shutr-beh.md) - [Signature Header Authentication](https://techdocs.akamai.com/property-mgr/docs/signature-header-auth.md) - [Simulate Error Response Code](https://techdocs.akamai.com/property-mgr/docs/simulate-err-response-code.md) - [Site Failover](https://techdocs.akamai.com/property-mgr/docs/site-failover.md) - [Site Shield](https://techdocs.akamai.com/property-mgr/docs/siteshield-beh.md) - [SPDY](https://techdocs.akamai.com/property-mgr/docs/spdy-beh.md) - [Standard TLS Migration](https://techdocs.akamai.com/property-mgr/docs/standard-tls-migration.md) - [Standard TLS Migration Override](https://techdocs.akamai.com/property-mgr/docs/standard-tls-migration-override.md) - [Strict Header Parsing](https://techdocs.akamai.com/property-mgr/docs/strict-header-parsing.md) - [Subcustomer Enablement](https://techdocs.akamai.com/property-mgr/docs/subcustomer-enablement.md) - [SureRoute](https://techdocs.akamai.com/property-mgr/docs/sureroute-beh.md) - [TCP Optimizations](https://techdocs.akamai.com/property-mgr/docs/tcp-optimizations.md) - [Tiered Distribution](https://techdocs.akamai.com/property-mgr/docs/tiered-dist.md) - [Tiered Distribution Customization](https://techdocs.akamai.com/property-mgr/docs/tiered-distribution-customization.md) - [Tiered Distribution for API Acceleration](https://techdocs.akamai.com/property-mgr/docs/tiered-dist-api-accel.md) - [UID Configuration](https://techdocs.akamai.com/property-mgr/docs/uid-configuration.md) - [Validate Entity Tag (ETag)](https://techdocs.akamai.com/property-mgr/docs/val-entity-tag.md) - [Video Manager Powered by Cloudinary](https://techdocs.akamai.com/property-mgr/docs/video-manager-cloudinary.md) - [Visitor Prioritization Cloudlet](https://techdocs.akamai.com/property-mgr/docs/visitor-prioritization-cloudlet.md) - [Visitor Prioritization Powered by Queue-it (BETA)](https://techdocs.akamai.com/property-mgr/docs/visitor-prioritization-queueit.md) - [Watermark Token](https://techdocs.akamai.com/property-mgr/docs/wmk-token.md) - [Watermarking](https://techdocs.akamai.com/property-mgr/docs/wmk-amd.md) - [Web Application Firewall](https://techdocs.akamai.com/property-mgr/docs/web-app-firewall.md) - [WebDAV](https://techdocs.akamai.com/property-mgr/docs/webdav-beh.md) - [WebSockets](https://techdocs.akamai.com/property-mgr/docs/websockets-support.md) - [Review your configuration](https://techdocs.akamai.com/property-mgr/docs/review-config.md) - [Activate your property](https://techdocs.akamai.com/property-mgr/docs/activate-prop.md) - [Activate on staging](https://techdocs.akamai.com/property-mgr/docs/activate-stage.md) - [Test your property](https://techdocs.akamai.com/property-mgr/docs/test-https.md) - [Activate on production](https://techdocs.akamai.com/property-mgr/docs/activate-prod.md) - [How activation works](https://techdocs.akamai.com/property-mgr/docs/how-activation-works.md) - [Deactivate your property](https://techdocs.akamai.com/property-mgr/docs/deactivate-your-property.md) - [Delete a property](https://techdocs.akamai.com/property-mgr/docs/delete-a-property.md) - [Upgrade from Configuration Manager](https://techdocs.akamai.com/property-mgr/docs/upgrade-prop-manager.md) - [Troubleshoot Property Manager](https://techdocs.akamai.com/property-mgr/docs/troubleshoot-property-manager.md) ## API Reference - [Property Manager API](https://techdocs.akamai.com/property-mgr/reference/api.md) - [API summary](https://techdocs.akamai.com/property-mgr/reference/api-summary.md) - [Get started](https://techdocs.akamai.com/property-mgr/reference/api-get-started.md) - [Onboard a property with a CPS-managed certificate](https://techdocs.akamai.com/property-mgr/reference/onboard-a-custom-cert-property.md) - [Onboard a property with a Default DV certificate](https://techdocs.akamai.com/property-mgr/reference/onboard-a-secure-by-default-property.md) - [Onboard a property with Default DV certificate and advanced domain validation in Multi-CDN scenario](https://techdocs.akamai.com/property-mgr/reference/add-hn-with-default-cert-advanced-methods-multi-cdn.md) - [Onboard a property with Default DV certificate and advanced domain validation for SaaS/PaaS/IaaS provider](https://techdocs.akamai.com/property-mgr/reference/add-hn-with-default-cert-advanced-methods-saas.md) - [Onboard a property with a CCM certificate](https://techdocs.akamai.com/property-mgr/reference/onboard-a-property-with-a-ccm-certificate.md) - [Clone a property](https://techdocs.akamai.com/property-mgr/reference/clone-a-property.md) - [Modify current property settings](https://techdocs.akamai.com/property-mgr/reference/modify-current-property-settings.md) - [Manage hostnames](https://techdocs.akamai.com/property-mgr/reference/modify-property-hostnames.md) - [Activate a property](https://techdocs.akamai.com/property-mgr/reference/activate-a-property.md) - [Add hostnames to the hostname bucket](https://techdocs.akamai.com/property-mgr/reference/add-hostnames-to-the-hostname-bucket.md) - [Split your configuration into microservices](https://techdocs.akamai.com/property-mgr/reference/split-your-configuration-into-microservices.md) - [Share common settings across properties](https://techdocs.akamai.com/property-mgr/reference/share-common-settings-across-properties.md) - [API versioning](https://techdocs.akamai.com/property-mgr/reference/api-versioning.md) - [Data conventions](https://techdocs.akamai.com/property-mgr/reference/data-conventions.md) - [ID prefixes](https://techdocs.akamai.com/property-mgr/reference/id-prefixes.md) - [Rate and resource limiting](https://techdocs.akamai.com/property-mgr/reference/rate-and-resource-limiting.md) - [Concurrency control](https://techdocs.akamai.com/property-mgr/reference/concurrency-control.md) - [Known issues](https://techdocs.akamai.com/property-mgr/reference/known-issues.md) - [Restart a Default DV certificate validation](https://techdocs.akamai.com/property-mgr/reference/re-launch-default-certificate-validation.md) - [Debug variables](https://techdocs.akamai.com/property-mgr/reference/debug-variables.md) - [Rule tree errors and warnings](https://techdocs.akamai.com/property-mgr/reference/rule-tree-errors-and-warnings.md) - [Validation errors](https://techdocs.akamai.com/property-mgr/reference/validation-errors.md) - [Activation error handling](https://techdocs.akamai.com/property-mgr/reference/property-activation-error-handling.md) - [Errors](https://techdocs.akamai.com/property-mgr/reference/api-errors.md) - [400](https://techdocs.akamai.com/property-mgr/reference/400.md) - [401](https://techdocs.akamai.com/property-mgr/reference/401.md) - [403](https://techdocs.akamai.com/property-mgr/reference/403.md) - [404](https://techdocs.akamai.com/property-mgr/reference/404.md) - [405](https://techdocs.akamai.com/property-mgr/reference/405.md) - [406](https://techdocs.akamai.com/property-mgr/reference/406.md) - [409](https://techdocs.akamai.com/property-mgr/reference/409.md) - [412](https://techdocs.akamai.com/property-mgr/reference/412.md) - [413](https://techdocs.akamai.com/property-mgr/reference/413.md) - [415](https://techdocs.akamai.com/property-mgr/reference/415.md) - [422](https://techdocs.akamai.com/property-mgr/reference/422.md) - [429](https://techdocs.akamai.com/property-mgr/reference/429.md) - [500](https://techdocs.akamai.com/property-mgr/reference/500.md) - [Rule trees](https://techdocs.akamai.com/property-mgr/reference/rule-trees.md) - [The default rule](https://techdocs.akamai.com/property-mgr/reference/the-default-rule.md) - [Behaviors](https://techdocs.akamai.com/property-mgr/reference/behaviors.md) - [Criteria](https://techdocs.akamai.com/property-mgr/reference/criteria.md) - [Includes](https://techdocs.akamai.com/property-mgr/reference/includes.md) - [Advanced and locked features](https://techdocs.akamai.com/property-mgr/reference/advanced-and-locked-features.md) - [Custom behaviors and overrides](https://techdocs.akamai.com/property-mgr/reference/custom-behaviors-and-overrides.md) - [Dynamic rule updates](https://techdocs.akamai.com/property-mgr/reference/dynamic-rule-format-updates.md) - [Rule format schemas](https://techdocs.akamai.com/property-mgr/reference/rule-format-schemas.md) - [Use cases and best practices](https://techdocs.akamai.com/property-mgr/reference/validation-best-practices.md) - [Variables](https://techdocs.akamai.com/property-mgr/reference/variables.md) - [Insert a variable](https://techdocs.akamai.com/property-mgr/reference/insert-a-variable.md) - [Built-in system variables](https://techdocs.akamai.com/property-mgr/reference/built-in-system-variables.md) - [Declare a variable](https://techdocs.akamai.com/property-mgr/reference/declare-a-variable.md) - [Assign a variable](https://techdocs.akamai.com/property-mgr/reference/assign-a-variable.md) - [Modify a variable](https://techdocs.akamai.com/property-mgr/reference/modify-a-variable.md) - [Variables within includes](https://techdocs.akamai.com/property-mgr/reference/variables-with-includes.md) - [Bulk Search and Update](https://techdocs.akamai.com/property-mgr/reference/bulk-search-and-update.md) - [Sample workflow](https://techdocs.akamai.com/property-mgr/reference/sample-workflow.md) - [Sample bulk updates](https://techdocs.akamai.com/property-mgr/reference/sample-bulk-updates.md) - [Bulk searches](https://techdocs.akamai.com/property-mgr/reference/bulk-searches.md) - [Bulk versioning](https://techdocs.akamai.com/property-mgr/reference/bulk-versioning.md) - [Bulk patches](https://techdocs.akamai.com/property-mgr/reference/bulk-patches.md) - [Bulk activations](https://techdocs.akamai.com/property-mgr/reference/bulk-activations.md) - [Contextual searches](https://techdocs.akamai.com/property-mgr/reference/contextual-searches.md) - [Possible mismatches](https://techdocs.akamai.com/property-mgr/reference/possible-mismatches.md) - [Replace arrays or objects](https://techdocs.akamai.com/property-mgr/reference/replace-arrays-or-objects.md) - [Remove array elements](https://techdocs.akamai.com/property-mgr/reference/remove-array-elements.md) - [Add or remove behaviors and rules](https://techdocs.akamai.com/property-mgr/reference/add-or-remove-behaviors-and-rules.md) - [Make conditional changes](https://techdocs.akamai.com/property-mgr/reference/make-conditional-changes.md) - [latest behaviors](https://techdocs.akamai.com/property-mgr/reference/latest-behaviors.md) - [adScalerCircuitBreaker](https://techdocs.akamai.com/property-mgr/reference/latest-ad-scaler-circuit-breaker.md) - [adaptiveAcceleration](https://techdocs.akamai.com/property-mgr/reference/latest-adaptive-acceleration.md) - [advanced](https://techdocs.akamai.com/property-mgr/reference/latest-advanced.md) - [aggregatedReporting](https://techdocs.akamai.com/property-mgr/reference/latest-aggregated-reporting.md) - [akamaizer](https://techdocs.akamai.com/property-mgr/reference/latest-akamaizer.md) - [akamaizerTag](https://techdocs.akamai.com/property-mgr/reference/latest-akamaizer-tag.md) - [allHttpInCacheHierarchy](https://techdocs.akamai.com/property-mgr/reference/latest-all-http-in-cache-hierarchy.md) - [allowCachingOnCommercialNetwork](https://techdocs.akamai.com/property-mgr/reference/latest-allow-caching-on-commercial-network.md) - [allowCloudletsOrigins](https://techdocs.akamai.com/property-mgr/reference/latest-allow-cloudlets-origins.md) - [allowDelete](https://techdocs.akamai.com/property-mgr/reference/latest-allow-delete.md) - [allowHTTPSCacheKeySharing](https://techdocs.akamai.com/property-mgr/reference/latest-allow-httpscache-key-sharing.md) - [allowHTTPSDowngrade](https://techdocs.akamai.com/property-mgr/reference/latest-allow-httpsdowngrade.md) - [allowOptions](https://techdocs.akamai.com/property-mgr/reference/latest-allow-options.md) - [allowPatch](https://techdocs.akamai.com/property-mgr/reference/latest-allow-patch.md) - [allowPost](https://techdocs.akamai.com/property-mgr/reference/latest-allow-post.md) - [allowPut](https://techdocs.akamai.com/property-mgr/reference/latest-allow-put.md) - [allowTransferEncoding](https://techdocs.akamai.com/property-mgr/reference/latest-allow-transfer-encoding.md) - [altSvcHeader](https://techdocs.akamai.com/property-mgr/reference/latest-alt-svc-header.md) - [apiPrioritization](https://techdocs.akamai.com/property-mgr/reference/latest-api-prioritization.md) - [applicationLoadBalancer](https://techdocs.akamai.com/property-mgr/reference/latest-application-load-balancer.md) - [audienceSegmentation](https://techdocs.akamai.com/property-mgr/reference/latest-audience-segmentation.md) - [autoDomainValidation](https://techdocs.akamai.com/property-mgr/reference/latest-auto-domain-validation.md) - [baseDirectory](https://techdocs.akamai.com/property-mgr/reference/latest-base-directory.md) - [bossBeaconing](https://techdocs.akamai.com/property-mgr/reference/latest-boss-beaconing.md) - [breadcrumbs](https://techdocs.akamai.com/property-mgr/reference/latest-breadcrumbs.md) - [breakConnection](https://techdocs.akamai.com/property-mgr/reference/latest-break-connection.md) - [brotli](https://techdocs.akamai.com/property-mgr/reference/latest-brotli.md) - [cacheError](https://techdocs.akamai.com/property-mgr/reference/latest-cache-error.md) - [cacheId](https://techdocs.akamai.com/property-mgr/reference/latest-cache-id.md) - [cacheKeyIgnoreCase](https://techdocs.akamai.com/property-mgr/reference/latest-cache-key-ignore-case.md) - [cacheKeyQueryParams](https://techdocs.akamai.com/property-mgr/reference/latest-cache-key-query-params.md) - [cacheKeyRewrite](https://techdocs.akamai.com/property-mgr/reference/latest-cache-key-rewrite.md) - [cachePost](https://techdocs.akamai.com/property-mgr/reference/latest-cache-post.md) - [cacheRedirect](https://techdocs.akamai.com/property-mgr/reference/latest-cache-redirect.md) - [cacheTag](https://techdocs.akamai.com/property-mgr/reference/latest-cache-tag.md) - [cacheTagVisible](https://techdocs.akamai.com/property-mgr/reference/latest-cache-tag-visible.md) - [caching](https://techdocs.akamai.com/property-mgr/reference/latest-caching.md) - [centralAuthorization](https://techdocs.akamai.com/property-mgr/reference/latest-central-authorization.md) - [chaseRedirects](https://techdocs.akamai.com/property-mgr/reference/latest-chase-redirects.md) - [clientCertificateAuth](https://techdocs.akamai.com/property-mgr/reference/latest-client-certificate-auth.md) - [clientCharacteristics](https://techdocs.akamai.com/property-mgr/reference/latest-client-characteristics.md) - [cloudInterconnects](https://techdocs.akamai.com/property-mgr/reference/latest-cloud-interconnects.md) - [cloudWrapper](https://techdocs.akamai.com/property-mgr/reference/latest-cloud-wrapper.md) - [cloudWrapperAdvanced](https://techdocs.akamai.com/property-mgr/reference/latest-cloud-wrapper-advanced.md) - [commonMediaClientData](https://techdocs.akamai.com/property-mgr/reference/latest-common-media-client-data.md) - [constructResponse](https://techdocs.akamai.com/property-mgr/reference/latest-construct-response.md) - [contentCharacteristics](https://techdocs.akamai.com/property-mgr/reference/latest-content-characteristics.md) - [contentCharacteristicsAMD](https://techdocs.akamai.com/property-mgr/reference/latest-content-characteristics-amd.md) - [contentCharacteristicsDD](https://techdocs.akamai.com/property-mgr/reference/latest-content-characteristics-dd.md) - [contentCharacteristicsWsdLive](https://techdocs.akamai.com/property-mgr/reference/latest-content-characteristics-wsd-live.md) - [contentTargetingProtection](https://techdocs.akamai.com/property-mgr/reference/latest-content-targeting-protection.md) - [corsSupport](https://techdocs.akamai.com/property-mgr/reference/latest-cors-support.md) - [cpCode](https://techdocs.akamai.com/property-mgr/reference/latest-cp-code.md) - [customBehavior](https://techdocs.akamai.com/property-mgr/reference/latest-custom-behavior.md) - [datastream](https://techdocs.akamai.com/property-mgr/reference/latest-datastream.md) - [deliveryReceipt](https://techdocs.akamai.com/property-mgr/reference/latest-delivery-receipt.md) - [denyAccess](https://techdocs.akamai.com/property-mgr/reference/latest-deny-access.md) - [denyDirectFailoverAccess](https://techdocs.akamai.com/property-mgr/reference/latest-deny-direct-failover-access.md) - [deviceCharacteristicCacheId](https://techdocs.akamai.com/property-mgr/reference/latest-device-characteristic-cache-id.md) - [deviceCharacteristicHeader](https://techdocs.akamai.com/property-mgr/reference/latest-device-characteristic-header.md) - [dnsAsyncRefresh](https://techdocs.akamai.com/property-mgr/reference/latest-dns-async-refresh.md) - [dnsPrefresh](https://techdocs.akamai.com/property-mgr/reference/latest-dns-prefresh.md) - [downgradeProtocol](https://techdocs.akamai.com/property-mgr/reference/latest-downgrade-protocol.md) - [downloadCompleteMarker](https://techdocs.akamai.com/property-mgr/reference/latest-download-complete-marker.md) - [downloadNotification](https://techdocs.akamai.com/property-mgr/reference/latest-download-notification.md) - [downstreamCache](https://techdocs.akamai.com/property-mgr/reference/latest-downstream-cache.md) - [dynamicThroughtputOptimization](https://techdocs.akamai.com/property-mgr/reference/latest-dynamic-throughtput-optimization.md) - [dynamicThroughtputOptimizationOverride](https://techdocs.akamai.com/property-mgr/reference/latest-dynamic-throughtput-optimization-override.md) - [earlyData](https://techdocs.akamai.com/property-mgr/reference/latest-early-data.md) - [earlyDataAdvanced](https://techdocs.akamai.com/property-mgr/reference/latest-early-data-advanced.md) - [earlyHints](https://techdocs.akamai.com/property-mgr/reference/latest-early-hints.md) - [edgeConnect](https://techdocs.akamai.com/property-mgr/reference/latest-edge-connect.md) - [edgeLoadBalancingAdvanced](https://techdocs.akamai.com/property-mgr/reference/latest-edge-load-balancing-advanced.md) - [edgeLoadBalancingDataCenter](https://techdocs.akamai.com/property-mgr/reference/latest-edge-load-balancing-data-center.md) - [edgeLoadBalancingOrigin](https://techdocs.akamai.com/property-mgr/reference/latest-edge-load-balancing-origin.md) - [edgeOriginAuthorization](https://techdocs.akamai.com/property-mgr/reference/latest-edge-origin-authorization.md) - [edgeRedirector](https://techdocs.akamai.com/property-mgr/reference/latest-edge-redirector.md) - [edgeScape](https://techdocs.akamai.com/property-mgr/reference/latest-edge-scape.md) - [edgeSideIncludes](https://techdocs.akamai.com/property-mgr/reference/latest-edge-side-includes.md) - [edgeWorker](https://techdocs.akamai.com/property-mgr/reference/latest-edge-worker.md) - [enforceMtlsSettings](https://techdocs.akamai.com/property-mgr/reference/latest-enforce-mtls-settings.md) - [enhancedAkamaiProtocol](https://techdocs.akamai.com/property-mgr/reference/latest-enhanced-akamai-protocol.md) - [enhancedDebug](https://techdocs.akamai.com/property-mgr/reference/latest-enhanced-debug.md) - [enhancedProxyDetection](https://techdocs.akamai.com/property-mgr/reference/latest-enhanced-proxy-detection.md) - [epdForwardHeaderEnrichment](https://techdocs.akamai.com/property-mgr/reference/latest-epd-forward-header-enrichment.md) - [failAction](https://techdocs.akamai.com/property-mgr/reference/latest-fail-action.md) - [failoverBotManagerFeatureCompatibility](https://techdocs.akamai.com/property-mgr/reference/latest-failover-bot-manager-feature-compatibility.md) - [fastInvalidate](https://techdocs.akamai.com/property-mgr/reference/latest-fast-invalidate.md) - [fips](https://techdocs.akamai.com/property-mgr/reference/latest-fips.md) - [firstPartyMarketing](https://techdocs.akamai.com/property-mgr/reference/latest-first-party-marketing.md) - [firstPartyMarketingPlus](https://techdocs.akamai.com/property-mgr/reference/latest-first-party-marketing-plus.md) - [forwardRewrite](https://techdocs.akamai.com/property-mgr/reference/latest-forward-rewrite.md) - [g2oheader](https://techdocs.akamai.com/property-mgr/reference/latest-g2oheader.md) - [gRPC](https://techdocs.akamai.com/property-mgr/reference/latest-g-rpc.md) - [globalRequestNumber](https://techdocs.akamai.com/property-mgr/reference/latest-global-request-number.md) - [googleTagGateway](https://techdocs.akamai.com/property-mgr/reference/latest-google-tag-gateway.md) - [networkConditionsHeader](https://techdocs.akamai.com/property-mgr/reference/latest-network-conditions-header.md) - [graphqlCaching](https://techdocs.akamai.com/property-mgr/reference/latest-graphql-caching.md) - [gzipResponse](https://techdocs.akamai.com/property-mgr/reference/latest-gzip-response.md) - [hdDataAdvanced](https://techdocs.akamai.com/property-mgr/reference/latest-hd-data-advanced.md) - [healthDetection](https://techdocs.akamai.com/property-mgr/reference/latest-health-detection.md) - [hsafEipBinding](https://techdocs.akamai.com/property-mgr/reference/latest-hsaf-eip-binding.md) - [http2](https://techdocs.akamai.com/property-mgr/reference/latest-http2.md) - [http3](https://techdocs.akamai.com/property-mgr/reference/latest-http3.md) - [httpStrictTransportSecurity](https://techdocs.akamai.com/property-mgr/reference/latest-http-strict-transport-security.md) - [httpToHttpsUpgrade](https://techdocs.akamai.com/property-mgr/reference/latest-http-to-https-upgrade.md) - [imOverride](https://techdocs.akamai.com/property-mgr/reference/latest-im-override.md) - [imageManager](https://techdocs.akamai.com/property-mgr/reference/latest-image-manager.md) - [imageManagerVideo](https://techdocs.akamai.com/property-mgr/reference/latest-image-manager-video.md) - [include](https://techdocs.akamai.com/property-mgr/reference/latest-include.md) - [instant](https://techdocs.akamai.com/property-mgr/reference/latest-instant.md) - [instantConfig](https://techdocs.akamai.com/property-mgr/reference/latest-instant-config.md) - [largeFileOptimization](https://techdocs.akamai.com/property-mgr/reference/latest-large-file-optimization.md) - [largeFileOptimizationAdvanced](https://techdocs.akamai.com/property-mgr/reference/latest-large-file-optimization-advanced.md) - [limitBitRate](https://techdocs.akamai.com/property-mgr/reference/latest-limit-bit-rate.md) - [localhostLoopbackProtection](https://techdocs.akamai.com/property-mgr/reference/latest-localhost-loopback-protection.md) - [logCustom](https://techdocs.akamai.com/property-mgr/reference/latest-log-custom.md) - [mPulse](https://techdocs.akamai.com/property-mgr/reference/latest-m-pulse.md) - [manifestPersonalization](https://techdocs.akamai.com/property-mgr/reference/latest-manifest-personalization.md) - [manifestRerouting](https://techdocs.akamai.com/property-mgr/reference/latest-manifest-rerouting.md) - [manualServerPush](https://techdocs.akamai.com/property-mgr/reference/latest-manual-server-push.md) - [mediaAcceleration](https://techdocs.akamai.com/property-mgr/reference/latest-media-acceleration.md) - [mediaAccelerationQuicOptout](https://techdocs.akamai.com/property-mgr/reference/latest-media-acceleration-quic-optout.md) - [mediaClient](https://techdocs.akamai.com/property-mgr/reference/latest-media-client.md) - [mediaFileRetrievalOptimization](https://techdocs.akamai.com/property-mgr/reference/latest-media-file-retrieval-optimization.md) - [mediaOriginFailover](https://techdocs.akamai.com/property-mgr/reference/latest-media-origin-failover.md) - [metadataCaching](https://techdocs.akamai.com/property-mgr/reference/latest-metadata-caching.md) - [mobileSdkPerformance](https://techdocs.akamai.com/property-mgr/reference/latest-mobile-sdk-performance.md) - [modifyIncomingRequestHeader](https://techdocs.akamai.com/property-mgr/reference/latest-modify-incoming-request-header.md) - [modifyIncomingResponseHeader](https://techdocs.akamai.com/property-mgr/reference/latest-modify-incoming-response-header.md) - [modifyOutgoingRequestHeader](https://techdocs.akamai.com/property-mgr/reference/latest-modify-outgoing-request-header.md) - [modifyOutgoingResponseHeader](https://techdocs.akamai.com/property-mgr/reference/latest-modify-outgoing-response-header.md) - [modifyViaHeader](https://techdocs.akamai.com/property-mgr/reference/latest-modify-via-header.md) - [mtlsOriginKeystore](https://techdocs.akamai.com/property-mgr/reference/latest-mtls-origin-keystore.md) - [optimizeTextStreaming](https://techdocs.akamai.com/property-mgr/reference/latest-optimize-text-streaming.md) - [origin](https://techdocs.akamai.com/property-mgr/reference/latest-origin.md) - [originCharacteristics](https://techdocs.akamai.com/property-mgr/reference/latest-origin-characteristics.md) - [originCharacteristicsWsd](https://techdocs.akamai.com/property-mgr/reference/latest-origin-characteristics-wsd.md) - [originFailureRecoveryMethod](https://techdocs.akamai.com/property-mgr/reference/latest-origin-failure-recovery-method.md) - [originFailureRecoveryPolicy](https://techdocs.akamai.com/property-mgr/reference/latest-origin-failure-recovery-policy.md) - [originIpAcl](https://techdocs.akamai.com/property-mgr/reference/latest-origin-ip-acl.md) - [permissionsPolicy](https://techdocs.akamai.com/property-mgr/reference/latest-permissions-policy.md) - [persistentClientConnection](https://techdocs.akamai.com/property-mgr/reference/latest-persistent-client-connection.md) - [persistentConnection](https://techdocs.akamai.com/property-mgr/reference/latest-persistent-connection.md) - [personallyIdentifiableInformation](https://techdocs.akamai.com/property-mgr/reference/latest-personally-identifiable-information.md) - [phasedRelease](https://techdocs.akamai.com/property-mgr/reference/latest-phased-release.md) - [pqcClientToEdge](https://techdocs.akamai.com/property-mgr/reference/latest-pqc-client-to-edge.md) - [pqcOrigin](https://techdocs.akamai.com/property-mgr/reference/latest-pqc-origin.md) - [preconnect](https://techdocs.akamai.com/property-mgr/reference/latest-preconnect.md) - [predictiveContentDelivery](https://techdocs.akamai.com/property-mgr/reference/latest-predictive-content-delivery.md) - [predictivePrefetching](https://techdocs.akamai.com/property-mgr/reference/latest-predictive-prefetching.md) - [prefetch](https://techdocs.akamai.com/property-mgr/reference/latest-prefetch.md) - [prefetchable](https://techdocs.akamai.com/property-mgr/reference/latest-prefetchable.md) - [prefreshCache](https://techdocs.akamai.com/property-mgr/reference/latest-prefresh-cache.md) - [shutr](https://techdocs.akamai.com/property-mgr/reference/latest-shutr.md) - [quicBeta](https://techdocs.akamai.com/property-mgr/reference/latest-quic-beta.md) - [randomSeek](https://techdocs.akamai.com/property-mgr/reference/latest-random-seek.md) - [rapid](https://techdocs.akamai.com/property-mgr/reference/latest-rapid.md) - [readTimeout](https://techdocs.akamai.com/property-mgr/reference/latest-read-timeout.md) - [realUserMonitoring](https://techdocs.akamai.com/property-mgr/reference/latest-real-user-monitoring.md) - [redirect](https://techdocs.akamai.com/property-mgr/reference/latest-redirect.md) - [redirectplus](https://techdocs.akamai.com/property-mgr/reference/latest-redirectplus.md) - [refererChecking](https://techdocs.akamai.com/property-mgr/reference/latest-referer-checking.md) - [removeQueryParameter](https://techdocs.akamai.com/property-mgr/reference/latest-remove-query-parameter.md) - [removeVary](https://techdocs.akamai.com/property-mgr/reference/latest-remove-vary.md) - [report](https://techdocs.akamai.com/property-mgr/reference/latest-report.md) - [requestClientHints](https://techdocs.akamai.com/property-mgr/reference/latest-request-client-hints.md) - [requestControl](https://techdocs.akamai.com/property-mgr/reference/latest-request-control.md) - [requestTypeMarker](https://techdocs.akamai.com/property-mgr/reference/latest-request-type-marker.md) - [resourceOptimizer](https://techdocs.akamai.com/property-mgr/reference/latest-resource-optimizer.md) - [resourceOptimizerExtendedCompatibility](https://techdocs.akamai.com/property-mgr/reference/latest-resource-optimizer-extended-compatibility.md) - [responseCode](https://techdocs.akamai.com/property-mgr/reference/latest-response-code.md) - [responseCookie](https://techdocs.akamai.com/property-mgr/reference/latest-response-cookie.md) - [restrictObjectCaching](https://techdocs.akamai.com/property-mgr/reference/latest-restrict-object-caching.md) - [returnCacheStatus](https://techdocs.akamai.com/property-mgr/reference/latest-return-cache-status.md) - [rewriteUrl](https://techdocs.akamai.com/property-mgr/reference/latest-rewrite-url.md) - [rumCustom](https://techdocs.akamai.com/property-mgr/reference/latest-rum-custom.md) - [saasDefinitions](https://techdocs.akamai.com/property-mgr/reference/latest-saas-definitions.md) - [salesForceCommerceCloudClient](https://techdocs.akamai.com/property-mgr/reference/latest-sales-force-commerce-cloud-client.md) - [salesForceCommerceCloudProvider](https://techdocs.akamai.com/property-mgr/reference/latest-sales-force-commerce-cloud-provider.md) - [salesForceCommerceCloudProviderHostHeader](https://techdocs.akamai.com/property-mgr/reference/latest-sales-force-commerce-cloud-provider-host-header.md) - [savePostDcaProcessing](https://techdocs.akamai.com/property-mgr/reference/latest-save-post-dca-processing.md) - [scheduleInvalidation](https://techdocs.akamai.com/property-mgr/reference/latest-schedule-invalidation.md) - [scriptManagement](https://techdocs.akamai.com/property-mgr/reference/latest-script-management.md) - [segmentedContentProtection](https://techdocs.akamai.com/property-mgr/reference/latest-segmented-content-protection.md) - [segmentedMediaOptimization](https://techdocs.akamai.com/property-mgr/reference/latest-segmented-media-optimization.md) - [segmentedMediaStreamingPrefetch](https://techdocs.akamai.com/property-mgr/reference/latest-segmented-media-streaming-prefetch.md) - [setVariable](https://techdocs.akamai.com/property-mgr/reference/latest-set-variable.md) - [simulateErrorCode](https://techdocs.akamai.com/property-mgr/reference/latest-simulate-error-code.md) - [siteShield](https://techdocs.akamai.com/property-mgr/reference/latest-site-shield.md) - [standardTLSMigration](https://techdocs.akamai.com/property-mgr/reference/latest-standard-tlsmigration.md) - [standardTLSMigrationOverride](https://techdocs.akamai.com/property-mgr/reference/latest-standard-tlsmigration-override.md) - [strictHeaderParsing](https://techdocs.akamai.com/property-mgr/reference/latest-strict-header-parsing.md) - [sureRoute](https://techdocs.akamai.com/property-mgr/reference/latest-sure-route.md) - [tcpOptimization](https://techdocs.akamai.com/property-mgr/reference/latest-tcp-optimization.md) - [teaLeaf](https://techdocs.akamai.com/property-mgr/reference/latest-tea-leaf.md) - [tieredDistribution](https://techdocs.akamai.com/property-mgr/reference/latest-tiered-distribution.md) - [tieredDistributionAdvanced](https://techdocs.akamai.com/property-mgr/reference/latest-tiered-distribution-advanced.md) - [tieredDistributionCustomization](https://techdocs.akamai.com/property-mgr/reference/latest-tiered-distribution-customization.md) - [timeout](https://techdocs.akamai.com/property-mgr/reference/latest-timeout.md) - [uidConfiguration](https://techdocs.akamai.com/property-mgr/reference/latest-uid-configuration.md) - [validateEntityTag](https://techdocs.akamai.com/property-mgr/reference/latest-validate-entity-tag.md) - [verifyTokenAuthorization](https://techdocs.akamai.com/property-mgr/reference/latest-verify-token-authorization.md) - [visitorPrioritization](https://techdocs.akamai.com/property-mgr/reference/latest-visitor-prioritization.md) - [visitorPrioritizationQueueIt](https://techdocs.akamai.com/property-mgr/reference/latest-visitor-prioritization-queue-it.md) - [watermarking](https://techdocs.akamai.com/property-mgr/reference/latest-watermarking.md) - [webApplicationFirewall](https://techdocs.akamai.com/property-mgr/reference/latest-web-application-firewall.md) - [webSockets](https://techdocs.akamai.com/property-mgr/reference/latest-web-sockets.md) - [webdav](https://techdocs.akamai.com/property-mgr/reference/latest-webdav.md) - [latest criteria](https://techdocs.akamai.com/property-mgr/reference/latest-criteria.md) - [advancedImMatch](https://techdocs.akamai.com/property-mgr/reference/latest-advanced-im-match.md) - [bucket](https://techdocs.akamai.com/property-mgr/reference/latest-bucket.md) - [cacheability](https://techdocs.akamai.com/property-mgr/reference/latest-cacheability.md) - [chinaCdnRegion](https://techdocs.akamai.com/property-mgr/reference/latest-china-cdn-region.md) - [clientCertificate](https://techdocs.akamai.com/property-mgr/reference/latest-client-certificate.md) - [clientIp](https://techdocs.akamai.com/property-mgr/reference/latest-client-ip.md) - [clientIpVersion](https://techdocs.akamai.com/property-mgr/reference/latest-client-ip-version.md) - [cloudletsOrigin](https://techdocs.akamai.com/property-mgr/reference/latest-cloudlets-origin.md) - [contentDeliveryNetwork](https://techdocs.akamai.com/property-mgr/reference/latest-content-delivery-network.md) - [contentType](https://techdocs.akamai.com/property-mgr/reference/latest-content-type.md) - [debugMode](https://techdocs.akamai.com/property-mgr/reference/latest-debug-mode.md) - [deviceCharacteristic](https://techdocs.akamai.com/property-mgr/reference/latest-device-characteristic.md) - [edgeWorkersFailure](https://techdocs.akamai.com/property-mgr/reference/latest-edge-workers-failure.md) - [fileExtension](https://techdocs.akamai.com/property-mgr/reference/latest-file-extension.md) - [filename](https://techdocs.akamai.com/property-mgr/reference/latest-filename.md) - [hostname](https://techdocs.akamai.com/property-mgr/reference/latest-hostname.md) - [matchAdvanced](https://techdocs.akamai.com/property-mgr/reference/latest-match-advanced.md) - [matchCpCode](https://techdocs.akamai.com/property-mgr/reference/latest-match-cp-code.md) - [matchResponseCode](https://techdocs.akamai.com/property-mgr/reference/latest-match-response-code.md) - [matchVariable](https://techdocs.akamai.com/property-mgr/reference/latest-match-variable.md) - [metadataStage](https://techdocs.akamai.com/property-mgr/reference/latest-metadata-stage.md) - [originTimeout](https://techdocs.akamai.com/property-mgr/reference/latest-origin-timeout.md) - [path](https://techdocs.akamai.com/property-mgr/reference/latest-path.md) - [queryStringParameter](https://techdocs.akamai.com/property-mgr/reference/latest-query-string-parameter.md) - [random](https://techdocs.akamai.com/property-mgr/reference/latest-random.md) - [recoveryConfig](https://techdocs.akamai.com/property-mgr/reference/latest-recovery-config.md) - [regularExpression](https://techdocs.akamai.com/property-mgr/reference/latest-regular-expression.md) - [requestCookie](https://techdocs.akamai.com/property-mgr/reference/latest-request-cookie.md) - [requestHeader](https://techdocs.akamai.com/property-mgr/reference/latest-request-header.md) - [requestMethod](https://techdocs.akamai.com/property-mgr/reference/latest-request-method.md) - [requestProtocol](https://techdocs.akamai.com/property-mgr/reference/latest-request-protocol.md) - [requestType](https://techdocs.akamai.com/property-mgr/reference/latest-request-type.md) - [responseHeader](https://techdocs.akamai.com/property-mgr/reference/latest-response-header.md) - [serverLocation](https://techdocs.akamai.com/property-mgr/reference/latest-server-location.md) - [time](https://techdocs.akamai.com/property-mgr/reference/latest-time.md) - [tokenAuthorization](https://techdocs.akamai.com/property-mgr/reference/latest-token-authorization.md) - [userAgent](https://techdocs.akamai.com/property-mgr/reference/latest-user-agent.md) - [userLocation](https://techdocs.akamai.com/property-mgr/reference/latest-user-location.md) - [userNetwork](https://techdocs.akamai.com/property-mgr/reference/latest-user-network.md) - [variableError](https://techdocs.akamai.com/property-mgr/reference/latest-variable-error.md) - [v2026-06-09 behaviors](https://techdocs.akamai.com/property-mgr/reference/ga-behaviors.md) - [adaptiveImageCompression](https://techdocs.akamai.com/property-mgr/reference/ga-adaptive-image-compression.md) - [adScalerCircuitBreaker](https://techdocs.akamai.com/property-mgr/reference/ga-ad-scaler-circuit-breaker.md) - [adaptiveAcceleration](https://techdocs.akamai.com/property-mgr/reference/ga-adaptive-acceleration.md) - [advanced](https://techdocs.akamai.com/property-mgr/reference/ga-advanced.md) - [aggregatedReporting](https://techdocs.akamai.com/property-mgr/reference/ga-aggregated-reporting.md) - [akamaizer](https://techdocs.akamai.com/property-mgr/reference/ga-akamaizer.md) - [akamaizerTag](https://techdocs.akamai.com/property-mgr/reference/ga-akamaizer-tag.md) - [allHttpInCacheHierarchy](https://techdocs.akamai.com/property-mgr/reference/ga-all-http-in-cache-hierarchy.md) - [allowCachingOnCommercialNetwork](https://techdocs.akamai.com/property-mgr/reference/ga-allow-caching-on-commercial-network.md) - [allowCloudletsOrigins](https://techdocs.akamai.com/property-mgr/reference/ga-allow-cloudlets-origins.md) - [allowDelete](https://techdocs.akamai.com/property-mgr/reference/ga-allow-delete.md) - [allowHTTPSCacheKeySharing](https://techdocs.akamai.com/property-mgr/reference/ga-allow-httpscache-key-sharing.md) - [allowHTTPSDowngrade](https://techdocs.akamai.com/property-mgr/reference/ga-allow-httpsdowngrade.md) - [allowOptions](https://techdocs.akamai.com/property-mgr/reference/ga-allow-options.md) - [allowPatch](https://techdocs.akamai.com/property-mgr/reference/ga-allow-patch.md) - [allowPost](https://techdocs.akamai.com/property-mgr/reference/ga-allow-post.md) - [allowPut](https://techdocs.akamai.com/property-mgr/reference/ga-allow-put.md) - [allowTransferEncoding](https://techdocs.akamai.com/property-mgr/reference/ga-allow-transfer-encoding.md) - [altSvcHeader](https://techdocs.akamai.com/property-mgr/reference/ga-alt-svc-header.md) - [apiPrioritization](https://techdocs.akamai.com/property-mgr/reference/ga-api-prioritization.md) - [applicationLoadBalancer](https://techdocs.akamai.com/property-mgr/reference/ga-application-load-balancer.md) - [audienceSegmentation](https://techdocs.akamai.com/property-mgr/reference/ga-audience-segmentation.md) - [autoDomainValidation](https://techdocs.akamai.com/property-mgr/reference/ga-auto-domain-validation.md) - [baseDirectory](https://techdocs.akamai.com/property-mgr/reference/ga-base-directory.md) - [bossBeaconing](https://techdocs.akamai.com/property-mgr/reference/ga-boss-beaconing.md) - [breadcrumbs](https://techdocs.akamai.com/property-mgr/reference/ga-breadcrumbs.md) - [breakConnection](https://techdocs.akamai.com/property-mgr/reference/ga-break-connection.md) - [brotli](https://techdocs.akamai.com/property-mgr/reference/ga-brotli.md) - [cacheError](https://techdocs.akamai.com/property-mgr/reference/ga-cache-error.md) - [cacheId](https://techdocs.akamai.com/property-mgr/reference/ga-cache-id.md) - [cacheKeyIgnoreCase](https://techdocs.akamai.com/property-mgr/reference/ga-cache-key-ignore-case.md) - [cacheKeyQueryParams](https://techdocs.akamai.com/property-mgr/reference/ga-cache-key-query-params.md) - [cacheKeyRewrite](https://techdocs.akamai.com/property-mgr/reference/ga-cache-key-rewrite.md) - [cachePost](https://techdocs.akamai.com/property-mgr/reference/ga-cache-post.md) - [cacheRedirect](https://techdocs.akamai.com/property-mgr/reference/ga-cache-redirect.md) - [cacheTag](https://techdocs.akamai.com/property-mgr/reference/ga-cache-tag.md) - [cacheTagVisible](https://techdocs.akamai.com/property-mgr/reference/ga-cache-tag-visible.md) - [caching](https://techdocs.akamai.com/property-mgr/reference/ga-caching.md) - [centralAuthorization](https://techdocs.akamai.com/property-mgr/reference/ga-central-authorization.md) - [chaseRedirects](https://techdocs.akamai.com/property-mgr/reference/ga-chase-redirects.md) - [clientCertificateAuth](https://techdocs.akamai.com/property-mgr/reference/ga-client-certificate-auth.md) - [clientCharacteristics](https://techdocs.akamai.com/property-mgr/reference/ga-client-characteristics.md) - [cloudInterconnects](https://techdocs.akamai.com/property-mgr/reference/ga-cloud-interconnects.md) - [cloudWrapper](https://techdocs.akamai.com/property-mgr/reference/ga-cloud-wrapper.md) - [cloudWrapperAdvanced](https://techdocs.akamai.com/property-mgr/reference/ga-cloud-wrapper-advanced.md) - [commonMediaClientData](https://techdocs.akamai.com/property-mgr/reference/ga-common-media-client-data.md) - [constructResponse](https://techdocs.akamai.com/property-mgr/reference/ga-construct-response.md) - [contentCharacteristics](https://techdocs.akamai.com/property-mgr/reference/ga-content-characteristics.md) - [contentCharacteristicsAMD](https://techdocs.akamai.com/property-mgr/reference/ga-content-characteristics-amd.md) - [contentCharacteristicsDD](https://techdocs.akamai.com/property-mgr/reference/ga-content-characteristics-dd.md) - [contentCharacteristicsWsdLive](https://techdocs.akamai.com/property-mgr/reference/ga-content-characteristics-wsd-live.md) - [contentTargetingProtection](https://techdocs.akamai.com/property-mgr/reference/ga-content-targeting-protection.md) - [corsSupport](https://techdocs.akamai.com/property-mgr/reference/ga-cors-support.md) - [cpCode](https://techdocs.akamai.com/property-mgr/reference/ga-cp-code.md) - [customBehavior](https://techdocs.akamai.com/property-mgr/reference/ga-custom-behavior.md) - [datastream](https://techdocs.akamai.com/property-mgr/reference/ga-datastream.md) - [deliveryReceipt](https://techdocs.akamai.com/property-mgr/reference/ga-delivery-receipt.md) - [denyAccess](https://techdocs.akamai.com/property-mgr/reference/ga-deny-access.md) - [denyDirectFailoverAccess](https://techdocs.akamai.com/property-mgr/reference/ga-deny-direct-failover-access.md) - [deviceCharacteristicCacheId](https://techdocs.akamai.com/property-mgr/reference/ga-device-characteristic-cache-id.md) - [deviceCharacteristicHeader](https://techdocs.akamai.com/property-mgr/reference/ga-device-characteristic-header.md) - [dnsAsyncRefresh](https://techdocs.akamai.com/property-mgr/reference/ga-dns-async-refresh.md) - [dnsPrefresh](https://techdocs.akamai.com/property-mgr/reference/ga-dns-prefresh.md) - [downgradeProtocol](https://techdocs.akamai.com/property-mgr/reference/ga-downgrade-protocol.md) - [downloadCompleteMarker](https://techdocs.akamai.com/property-mgr/reference/ga-download-complete-marker.md) - [downloadNotification](https://techdocs.akamai.com/property-mgr/reference/ga-download-notification.md) - [downstreamCache](https://techdocs.akamai.com/property-mgr/reference/ga-downstream-cache.md) - [dynamicThroughtputOptimization](https://techdocs.akamai.com/property-mgr/reference/ga-dynamic-throughtput-optimization.md) - [dynamicThroughtputOptimizationOverride](https://techdocs.akamai.com/property-mgr/reference/ga-dynamic-throughtput-optimization-override.md) - [earlyData](https://techdocs.akamai.com/property-mgr/reference/ga-early-data.md) - [earlyDataAdvanced](https://techdocs.akamai.com/property-mgr/reference/ga-early-data-advanced.md) - [earlyHints](https://techdocs.akamai.com/property-mgr/reference/ga-early-hints.md) - [inputValidation](https://techdocs.akamai.com/property-mgr/reference/ga-input-validation.md) - [edgeConnect](https://techdocs.akamai.com/property-mgr/reference/ga-edge-connect.md) - [edgeLoadBalancingAdvanced](https://techdocs.akamai.com/property-mgr/reference/ga-edge-load-balancing-advanced.md) - [edgeLoadBalancingDataCenter](https://techdocs.akamai.com/property-mgr/reference/ga-edge-load-balancing-data-center.md) - [edgeLoadBalancingOrigin](https://techdocs.akamai.com/property-mgr/reference/ga-edge-load-balancing-origin.md) - [edgeOriginAuthorization](https://techdocs.akamai.com/property-mgr/reference/ga-edge-origin-authorization.md) - [edgeRedirector](https://techdocs.akamai.com/property-mgr/reference/ga-edge-redirector.md) - [edgeScape](https://techdocs.akamai.com/property-mgr/reference/ga-edge-scape.md) - [edgeSideIncludes](https://techdocs.akamai.com/property-mgr/reference/ga-edge-side-includes.md) - [edgeWorker](https://techdocs.akamai.com/property-mgr/reference/ga-edge-worker.md) - [enforceMtlsSettings](https://techdocs.akamai.com/property-mgr/reference/ga-enforce-mtls-settings.md) - [enhancedAkamaiProtocol](https://techdocs.akamai.com/property-mgr/reference/ga-enhanced-akamai-protocol.md) - [enhancedDebug](https://techdocs.akamai.com/property-mgr/reference/ga-enhanced-debug.md) - [enhancedProxyDetection](https://techdocs.akamai.com/property-mgr/reference/ga-enhanced-proxy-detection.md) - [epdForwardHeaderEnrichment](https://techdocs.akamai.com/property-mgr/reference/ga-epd-forward-header-enrichment.md) - [failAction](https://techdocs.akamai.com/property-mgr/reference/ga-fail-action.md) - [failoverBotManagerFeatureCompatibility](https://techdocs.akamai.com/property-mgr/reference/ga-failover-bot-manager-feature-compatibility.md) - [fastInvalidate](https://techdocs.akamai.com/property-mgr/reference/ga-fast-invalidate.md) - [fips](https://techdocs.akamai.com/property-mgr/reference/ga-fips.md) - [firstPartyMarketing](https://techdocs.akamai.com/property-mgr/reference/ga-first-party-marketing.md) - [firstPartyMarketingPlus](https://techdocs.akamai.com/property-mgr/reference/ga-first-party-marketing-plus.md) - [forwardRewrite](https://techdocs.akamai.com/property-mgr/reference/ga-forward-rewrite.md) - [g2oheader](https://techdocs.akamai.com/property-mgr/reference/ga-g2oheader.md) - [gRPC](https://techdocs.akamai.com/property-mgr/reference/ga-g-rpc.md) - [globalRequestNumber](https://techdocs.akamai.com/property-mgr/reference/ga-global-request-number.md) - [googleTagGateway](https://techdocs.akamai.com/property-mgr/reference/ga-google-tag-gateway.md) - [graphqlCaching](https://techdocs.akamai.com/property-mgr/reference/ga-graphql-caching.md) - [gzipResponse](https://techdocs.akamai.com/property-mgr/reference/ga-gzip-response.md) - [hdDataAdvanced](https://techdocs.akamai.com/property-mgr/reference/ga-hd-data-advanced.md) - [healthDetection](https://techdocs.akamai.com/property-mgr/reference/ga-health-detection.md) - [hsafEipBinding](https://techdocs.akamai.com/property-mgr/reference/ga-hsaf-eip-binding.md) - [http2](https://techdocs.akamai.com/property-mgr/reference/ga-http2.md) - [http3](https://techdocs.akamai.com/property-mgr/reference/ga-http3.md) - [httpStrictTransportSecurity](https://techdocs.akamai.com/property-mgr/reference/ga-http-strict-transport-security.md) - [httpToHttpsUpgrade](https://techdocs.akamai.com/property-mgr/reference/ga-http-to-https-upgrade.md) - [imOverride](https://techdocs.akamai.com/property-mgr/reference/ga-im-override.md) - [imageManager](https://techdocs.akamai.com/property-mgr/reference/ga-image-manager.md) - [imageManagerVideo](https://techdocs.akamai.com/property-mgr/reference/ga-image-manager-video.md) - [include](https://techdocs.akamai.com/property-mgr/reference/ga-include.md) - [instant](https://techdocs.akamai.com/property-mgr/reference/ga-instant.md) - [instantConfig](https://techdocs.akamai.com/property-mgr/reference/ga-instant-config.md) - [largeFileOptimization](https://techdocs.akamai.com/property-mgr/reference/ga-large-file-optimization.md) - [largeFileOptimizationAdvanced](https://techdocs.akamai.com/property-mgr/reference/ga-large-file-optimization-advanced.md) - [limitBitRate](https://techdocs.akamai.com/property-mgr/reference/ga-limit-bit-rate.md) - [localhostLoopbackProtection](https://techdocs.akamai.com/property-mgr/reference/ga-localhost-loopback-protection.md) - [logCustom](https://techdocs.akamai.com/property-mgr/reference/ga-log-custom.md) - [mPulse](https://techdocs.akamai.com/property-mgr/reference/ga-m-pulse.md) - [manifestPersonalization](https://techdocs.akamai.com/property-mgr/reference/ga-manifest-personalization.md) - [manifestRerouting](https://techdocs.akamai.com/property-mgr/reference/ga-manifest-rerouting.md) - [manualServerPush](https://techdocs.akamai.com/property-mgr/reference/ga-manual-server-push.md) - [mediaAcceleration](https://techdocs.akamai.com/property-mgr/reference/ga-media-acceleration.md) - [mediaAccelerationQuicOptout](https://techdocs.akamai.com/property-mgr/reference/ga-media-acceleration-quic-optout.md) - [mediaClient](https://techdocs.akamai.com/property-mgr/reference/ga-media-client.md) - [shutr](https://techdocs.akamai.com/property-mgr/reference/ga-shutr.md) - [mediaFileRetrievalOptimization](https://techdocs.akamai.com/property-mgr/reference/ga-media-file-retrieval-optimization.md) - [mediaOriginFailover](https://techdocs.akamai.com/property-mgr/reference/ga-media-origin-failover.md) - [metadataCaching](https://techdocs.akamai.com/property-mgr/reference/ga-metadata-caching.md) - [mobileSdkPerformance](https://techdocs.akamai.com/property-mgr/reference/ga-mobile-sdk-performance.md) - [modifyIncomingRequestHeader](https://techdocs.akamai.com/property-mgr/reference/ga-modify-incoming-request-header.md) - [modifyIncomingResponseHeader](https://techdocs.akamai.com/property-mgr/reference/ga-modify-incoming-response-header.md) - [modifyOutgoingRequestHeader](https://techdocs.akamai.com/property-mgr/reference/ga-modify-outgoing-request-header.md) - [modifyOutgoingResponseHeader](https://techdocs.akamai.com/property-mgr/reference/ga-modify-outgoing-response-header.md) - [modifyViaHeader](https://techdocs.akamai.com/property-mgr/reference/ga-modify-via-header.md) - [mtlsOriginKeystore](https://techdocs.akamai.com/property-mgr/reference/ga-mtls-origin-keystore.md) - [optimizeTextStreaming](https://techdocs.akamai.com/property-mgr/reference/ga-optimize-text-streaming.md) - [origin](https://techdocs.akamai.com/property-mgr/reference/ga-origin.md) - [originCharacteristics](https://techdocs.akamai.com/property-mgr/reference/ga-origin-characteristics.md) - [originCharacteristicsWsd](https://techdocs.akamai.com/property-mgr/reference/ga-origin-characteristics-wsd.md) - [originFailureRecoveryMethod](https://techdocs.akamai.com/property-mgr/reference/ga-origin-failure-recovery-method.md) - [originFailureRecoveryPolicy](https://techdocs.akamai.com/property-mgr/reference/ga-origin-failure-recovery-policy.md) - [originIpAcl](https://techdocs.akamai.com/property-mgr/reference/ga-origin-ip-acl.md) - [permissionsPolicy](https://techdocs.akamai.com/property-mgr/reference/ga-permissions-policy.md) - [persistentClientConnection](https://techdocs.akamai.com/property-mgr/reference/ga-persistent-client-connection.md) - [persistentConnection](https://techdocs.akamai.com/property-mgr/reference/ga-persistent-connection.md) - [personallyIdentifiableInformation](https://techdocs.akamai.com/property-mgr/reference/ga-personally-identifiable-information.md) - [phasedRelease](https://techdocs.akamai.com/property-mgr/reference/ga-phased-release.md) - [pqcClientToEdge](https://techdocs.akamai.com/property-mgr/reference/ga-pqc-client-to-edge.md) - [pqcOrigin](https://techdocs.akamai.com/property-mgr/reference/ga-pqc-origin.md) - [preconnect](https://techdocs.akamai.com/property-mgr/reference/ga-preconnect.md) - [predictiveContentDelivery](https://techdocs.akamai.com/property-mgr/reference/ga-predictive-content-delivery.md) - [predictivePrefetching](https://techdocs.akamai.com/property-mgr/reference/ga-predictive-prefetching.md) - [prefetch](https://techdocs.akamai.com/property-mgr/reference/ga-prefetch.md) - [prefetchable](https://techdocs.akamai.com/property-mgr/reference/ga-prefetchable.md) - [prefreshCache](https://techdocs.akamai.com/property-mgr/reference/ga-prefresh-cache.md) - [quicBeta](https://techdocs.akamai.com/property-mgr/reference/ga-quic-beta.md) - [randomSeek](https://techdocs.akamai.com/property-mgr/reference/ga-random-seek.md) - [rapid](https://techdocs.akamai.com/property-mgr/reference/ga-rapid.md) - [readTimeout](https://techdocs.akamai.com/property-mgr/reference/ga-read-timeout.md) - [realUserMonitoring](https://techdocs.akamai.com/property-mgr/reference/ga-real-user-monitoring.md) - [redirect](https://techdocs.akamai.com/property-mgr/reference/ga-redirect.md) - [redirectplus](https://techdocs.akamai.com/property-mgr/reference/ga-redirectplus.md) - [refererChecking](https://techdocs.akamai.com/property-mgr/reference/ga-referer-checking.md) - [removeQueryParameter](https://techdocs.akamai.com/property-mgr/reference/ga-remove-query-parameter.md) - [removeVary](https://techdocs.akamai.com/property-mgr/reference/ga-remove-vary.md) - [report](https://techdocs.akamai.com/property-mgr/reference/ga-report.md) - [requestClientHints](https://techdocs.akamai.com/property-mgr/reference/ga-request-client-hints.md) - [requestControl](https://techdocs.akamai.com/property-mgr/reference/ga-request-control.md) - [requestTypeMarker](https://techdocs.akamai.com/property-mgr/reference/ga-request-type-marker.md) - [resourceOptimizer](https://techdocs.akamai.com/property-mgr/reference/ga-resource-optimizer.md) - [resourceOptimizerExtendedCompatibility](https://techdocs.akamai.com/property-mgr/reference/ga-resource-optimizer-extended-compatibility.md) - [responseCode](https://techdocs.akamai.com/property-mgr/reference/ga-response-code.md) - [responseCookie](https://techdocs.akamai.com/property-mgr/reference/ga-response-cookie.md) - [restrictObjectCaching](https://techdocs.akamai.com/property-mgr/reference/ga-restrict-object-caching.md) - [returnCacheStatus](https://techdocs.akamai.com/property-mgr/reference/ga-return-cache-status.md) - [rewriteUrl](https://techdocs.akamai.com/property-mgr/reference/ga-rewrite-url.md) - [rumCustom](https://techdocs.akamai.com/property-mgr/reference/ga-rum-custom.md) - [saasDefinitions](https://techdocs.akamai.com/property-mgr/reference/ga-saas-definitions.md) - [salesForceCommerceCloudClient](https://techdocs.akamai.com/property-mgr/reference/ga-sales-force-commerce-cloud-client.md) - [salesForceCommerceCloudProvider](https://techdocs.akamai.com/property-mgr/reference/ga-sales-force-commerce-cloud-provider.md) - [salesForceCommerceCloudProviderHostHeader](https://techdocs.akamai.com/property-mgr/reference/ga-sales-force-commerce-cloud-provider-host-header.md) - [savePostDcaProcessing](https://techdocs.akamai.com/property-mgr/reference/ga-save-post-dca-processing.md) - [scheduleInvalidation](https://techdocs.akamai.com/property-mgr/reference/ga-schedule-invalidation.md) - [scriptManagement](https://techdocs.akamai.com/property-mgr/reference/ga-script-management.md) - [segmentedContentProtection](https://techdocs.akamai.com/property-mgr/reference/ga-segmented-content-protection.md) - [segmentedMediaOptimization](https://techdocs.akamai.com/property-mgr/reference/ga-segmented-media-optimization.md) - [segmentedMediaStreamingPrefetch](https://techdocs.akamai.com/property-mgr/reference/ga-segmented-media-streaming-prefetch.md) - [setVariable](https://techdocs.akamai.com/property-mgr/reference/ga-set-variable.md) - [simulateErrorCode](https://techdocs.akamai.com/property-mgr/reference/ga-simulate-error-code.md) - [siteShield](https://techdocs.akamai.com/property-mgr/reference/ga-site-shield.md) - [standardTLSMigration](https://techdocs.akamai.com/property-mgr/reference/ga-standard-tlsmigration.md) - [standardTLSMigrationOverride](https://techdocs.akamai.com/property-mgr/reference/ga-standard-tlsmigration-override.md) - [strictHeaderParsing](https://techdocs.akamai.com/property-mgr/reference/ga-strict-header-parsing.md) - [sureRoute](https://techdocs.akamai.com/property-mgr/reference/ga-sure-route.md) - [tcpOptimization](https://techdocs.akamai.com/property-mgr/reference/ga-tcp-optimization.md) - [teaLeaf](https://techdocs.akamai.com/property-mgr/reference/ga-tea-leaf.md) - [tieredDistribution](https://techdocs.akamai.com/property-mgr/reference/ga-tiered-distribution.md) - [tieredDistributionAdvanced](https://techdocs.akamai.com/property-mgr/reference/ga-tiered-distribution-advanced.md) - [tieredDistributionCustomization](https://techdocs.akamai.com/property-mgr/reference/ga-tiered-distribution-customization.md) - [timeout](https://techdocs.akamai.com/property-mgr/reference/ga-timeout.md) - [uidConfiguration](https://techdocs.akamai.com/property-mgr/reference/ga-uid-configuration.md) - [validateEntityTag](https://techdocs.akamai.com/property-mgr/reference/ga-validate-entity-tag.md) - [verifyTokenAuthorization](https://techdocs.akamai.com/property-mgr/reference/ga-verify-token-authorization.md) - [visitorPrioritization](https://techdocs.akamai.com/property-mgr/reference/ga-visitor-prioritization.md) - [visitorPrioritizationQueueIt](https://techdocs.akamai.com/property-mgr/reference/ga-visitor-prioritization-queue-it.md) - [watermarking](https://techdocs.akamai.com/property-mgr/reference/ga-watermarking.md) - [webApplicationFirewall](https://techdocs.akamai.com/property-mgr/reference/ga-web-application-firewall.md) - [webSockets](https://techdocs.akamai.com/property-mgr/reference/ga-web-sockets.md) - [webdav](https://techdocs.akamai.com/property-mgr/reference/ga-webdav.md) - [v2026-06-09 criteria](https://techdocs.akamai.com/property-mgr/reference/ga-criteria.md) - [advancedImMatch](https://techdocs.akamai.com/property-mgr/reference/ga-advanced-im-match.md) - [bucket](https://techdocs.akamai.com/property-mgr/reference/ga-bucket.md) - [cacheability](https://techdocs.akamai.com/property-mgr/reference/ga-cacheability.md) - [chinaCdnRegion](https://techdocs.akamai.com/property-mgr/reference/ga-china-cdn-region.md) - [clientCertificate](https://techdocs.akamai.com/property-mgr/reference/ga-client-certificate.md) - [clientIp](https://techdocs.akamai.com/property-mgr/reference/ga-client-ip.md) - [clientIpVersion](https://techdocs.akamai.com/property-mgr/reference/ga-client-ip-version.md) - [cloudletsOrigin](https://techdocs.akamai.com/property-mgr/reference/ga-cloudlets-origin.md) - [contentDeliveryNetwork](https://techdocs.akamai.com/property-mgr/reference/ga-content-delivery-network.md) - [contentType](https://techdocs.akamai.com/property-mgr/reference/ga-content-type.md) - [debugMode](https://techdocs.akamai.com/property-mgr/reference/ga-debug-mode.md) - [deviceCharacteristic](https://techdocs.akamai.com/property-mgr/reference/ga-device-characteristic.md) - [edgeWorkersFailure](https://techdocs.akamai.com/property-mgr/reference/ga-edge-workers-failure.md) - [fileExtension](https://techdocs.akamai.com/property-mgr/reference/ga-file-extension.md) - [filename](https://techdocs.akamai.com/property-mgr/reference/ga-filename.md) - [hostname](https://techdocs.akamai.com/property-mgr/reference/ga-hostname.md) - [matchAdvanced](https://techdocs.akamai.com/property-mgr/reference/ga-match-advanced.md) - [matchCpCode](https://techdocs.akamai.com/property-mgr/reference/ga-match-cp-code.md) - [matchResponseCode](https://techdocs.akamai.com/property-mgr/reference/ga-match-response-code.md) - [matchVariable](https://techdocs.akamai.com/property-mgr/reference/ga-match-variable.md) - [metadataStage](https://techdocs.akamai.com/property-mgr/reference/ga-metadata-stage.md) - [originTimeout](https://techdocs.akamai.com/property-mgr/reference/ga-origin-timeout.md) - [path](https://techdocs.akamai.com/property-mgr/reference/ga-path.md) - [queryStringParameter](https://techdocs.akamai.com/property-mgr/reference/ga-query-string-parameter.md) - [random](https://techdocs.akamai.com/property-mgr/reference/ga-random.md) - [recoveryConfig](https://techdocs.akamai.com/property-mgr/reference/ga-recovery-config.md) - [regularExpression](https://techdocs.akamai.com/property-mgr/reference/ga-regular-expression.md) - [requestCookie](https://techdocs.akamai.com/property-mgr/reference/ga-request-cookie.md) - [requestHeader](https://techdocs.akamai.com/property-mgr/reference/ga-request-header.md) - [requestMethod](https://techdocs.akamai.com/property-mgr/reference/ga-request-method.md) - [requestProtocol](https://techdocs.akamai.com/property-mgr/reference/ga-request-protocol.md) - [requestType](https://techdocs.akamai.com/property-mgr/reference/ga-request-type.md) - [responseHeader](https://techdocs.akamai.com/property-mgr/reference/ga-response-header.md) - [serverLocation](https://techdocs.akamai.com/property-mgr/reference/ga-server-location.md) - [time](https://techdocs.akamai.com/property-mgr/reference/ga-time.md) - [tokenAuthorization](https://techdocs.akamai.com/property-mgr/reference/ga-token-authorization.md) - [userAgent](https://techdocs.akamai.com/property-mgr/reference/ga-user-agent.md) - [userLocation](https://techdocs.akamai.com/property-mgr/reference/ga-user-location.md) - [userNetwork](https://techdocs.akamai.com/property-mgr/reference/ga-user-network.md) - [variableError](https://techdocs.akamai.com/property-mgr/reference/ga-variable-error.md) - [v2026-05-05 behaviors](https://techdocs.akamai.com/property-mgr/reference/deprecated-behaviors.md) - [adaptiveImageCompression](https://techdocs.akamai.com/property-mgr/reference/deprecated-adaptive-image-compression.md) - [adScalerCircuitBreaker](https://techdocs.akamai.com/property-mgr/reference/deprecated-ad-scaler-circuit-breaker.md) - [adaptiveAcceleration](https://techdocs.akamai.com/property-mgr/reference/deprecated-adaptive-acceleration.md) - [advanced](https://techdocs.akamai.com/property-mgr/reference/deprecated-advanced.md) - [aggregatedReporting](https://techdocs.akamai.com/property-mgr/reference/deprecated-aggregated-reporting.md) - [akamaizer](https://techdocs.akamai.com/property-mgr/reference/deprecated-akamaizer.md) - [akamaizerTag](https://techdocs.akamai.com/property-mgr/reference/deprecated-akamaizer-tag.md) - [allHttpInCacheHierarchy](https://techdocs.akamai.com/property-mgr/reference/deprecated-all-http-in-cache-hierarchy.md) - [allowCachingOnCommercialNetwork](https://techdocs.akamai.com/property-mgr/reference/deprecated-allow-caching-on-commercial-network.md) - [allowCloudletsOrigins](https://techdocs.akamai.com/property-mgr/reference/deprecated-allow-cloudlets-origins.md) - [allowDelete](https://techdocs.akamai.com/property-mgr/reference/deprecated-allow-delete.md) - [allowHTTPSCacheKeySharing](https://techdocs.akamai.com/property-mgr/reference/deprecated-allow-httpscache-key-sharing.md) - [allowHTTPSDowngrade](https://techdocs.akamai.com/property-mgr/reference/deprecated-allow-httpsdowngrade.md) - [allowOptions](https://techdocs.akamai.com/property-mgr/reference/deprecated-allow-options.md) - [allowPatch](https://techdocs.akamai.com/property-mgr/reference/deprecated-allow-patch.md) - [allowPost](https://techdocs.akamai.com/property-mgr/reference/deprecated-allow-post.md) - [allowPut](https://techdocs.akamai.com/property-mgr/reference/deprecated-allow-put.md) - [allowTransferEncoding](https://techdocs.akamai.com/property-mgr/reference/deprecated-allow-transfer-encoding.md) - [altSvcHeader](https://techdocs.akamai.com/property-mgr/reference/deprecated-alt-svc-header.md) - [apiPrioritization](https://techdocs.akamai.com/property-mgr/reference/deprecated-api-prioritization.md) - [applicationLoadBalancer](https://techdocs.akamai.com/property-mgr/reference/deprecated-application-load-balancer.md) - [audienceSegmentation](https://techdocs.akamai.com/property-mgr/reference/deprecated-audience-segmentation.md) - [autoDomainValidation](https://techdocs.akamai.com/property-mgr/reference/deprecated-auto-domain-validation.md) - [baseDirectory](https://techdocs.akamai.com/property-mgr/reference/deprecated-base-directory.md) - [bossBeaconing](https://techdocs.akamai.com/property-mgr/reference/deprecated-boss-beaconing.md) - [breadcrumbs](https://techdocs.akamai.com/property-mgr/reference/deprecated-breadcrumbs.md) - [breakConnection](https://techdocs.akamai.com/property-mgr/reference/deprecated-break-connection.md) - [brotli](https://techdocs.akamai.com/property-mgr/reference/deprecated-brotli.md) - [cacheError](https://techdocs.akamai.com/property-mgr/reference/deprecated-cache-error.md) - [cacheId](https://techdocs.akamai.com/property-mgr/reference/deprecated-cache-id.md) - [cacheKeyIgnoreCase](https://techdocs.akamai.com/property-mgr/reference/deprecated-cache-key-ignore-case.md) - [cacheKeyQueryParams](https://techdocs.akamai.com/property-mgr/reference/deprecated-cache-key-query-params.md) - [cacheKeyRewrite](https://techdocs.akamai.com/property-mgr/reference/deprecated-cache-key-rewrite.md) - [cachePost](https://techdocs.akamai.com/property-mgr/reference/deprecated-cache-post.md) - [cacheRedirect](https://techdocs.akamai.com/property-mgr/reference/deprecated-cache-redirect.md) - [cacheTag](https://techdocs.akamai.com/property-mgr/reference/deprecated-cache-tag.md) - [cacheTagVisible](https://techdocs.akamai.com/property-mgr/reference/deprecated-cache-tag-visible.md) - [caching](https://techdocs.akamai.com/property-mgr/reference/deprecated-caching.md) - [centralAuthorization](https://techdocs.akamai.com/property-mgr/reference/deprecated-central-authorization.md) - [chaseRedirects](https://techdocs.akamai.com/property-mgr/reference/deprecated-chase-redirects.md) - [clientCertificateAuth](https://techdocs.akamai.com/property-mgr/reference/deprecated-client-certificate-auth.md) - [clientCharacteristics](https://techdocs.akamai.com/property-mgr/reference/deprecated-client-characteristics.md) - [cloudInterconnects](https://techdocs.akamai.com/property-mgr/reference/deprecated-cloud-interconnects.md) - [cloudWrapper](https://techdocs.akamai.com/property-mgr/reference/deprecated-cloud-wrapper.md) - [cloudWrapperAdvanced](https://techdocs.akamai.com/property-mgr/reference/deprecated-cloud-wrapper-advanced.md) - [commonMediaClientData](https://techdocs.akamai.com/property-mgr/reference/deprecated-common-media-client-data.md) - [constructResponse](https://techdocs.akamai.com/property-mgr/reference/deprecated-construct-response.md) - [contentCharacteristics](https://techdocs.akamai.com/property-mgr/reference/deprecated-content-characteristics.md) - [contentCharacteristicsAMD](https://techdocs.akamai.com/property-mgr/reference/deprecated-content-characteristics-amd.md) - [contentCharacteristicsDD](https://techdocs.akamai.com/property-mgr/reference/deprecated-content-characteristics-dd.md) - [contentCharacteristicsWsdLive](https://techdocs.akamai.com/property-mgr/reference/deprecated-content-characteristics-wsd-live.md) - [contentTargetingProtection](https://techdocs.akamai.com/property-mgr/reference/deprecated-content-targeting-protection.md) - [corsSupport](https://techdocs.akamai.com/property-mgr/reference/deprecated-cors-support.md) - [cpCode](https://techdocs.akamai.com/property-mgr/reference/deprecated-cp-code.md) - [customBehavior](https://techdocs.akamai.com/property-mgr/reference/deprecated-custom-behavior.md) - [datastream](https://techdocs.akamai.com/property-mgr/reference/deprecated-datastream.md) - [deliveryReceipt](https://techdocs.akamai.com/property-mgr/reference/deprecated-delivery-receipt.md) - [denyAccess](https://techdocs.akamai.com/property-mgr/reference/deprecated-deny-access.md) - [denyDirectFailoverAccess](https://techdocs.akamai.com/property-mgr/reference/deprecated-deny-direct-failover-access.md) - [deviceCharacteristicCacheId](https://techdocs.akamai.com/property-mgr/reference/deprecated-device-characteristic-cache-id.md) - [deviceCharacteristicHeader](https://techdocs.akamai.com/property-mgr/reference/deprecated-device-characteristic-header.md) - [dnsAsyncRefresh](https://techdocs.akamai.com/property-mgr/reference/deprecated-dns-async-refresh.md) - [dnsPrefresh](https://techdocs.akamai.com/property-mgr/reference/deprecated-dns-prefresh.md) - [downgradeProtocol](https://techdocs.akamai.com/property-mgr/reference/deprecated-downgrade-protocol.md) - [downloadCompleteMarker](https://techdocs.akamai.com/property-mgr/reference/deprecated-download-complete-marker.md) - [downloadNotification](https://techdocs.akamai.com/property-mgr/reference/deprecated-download-notification.md) - [downstreamCache](https://techdocs.akamai.com/property-mgr/reference/deprecated-downstream-cache.md) - [dynamicThroughtputOptimization](https://techdocs.akamai.com/property-mgr/reference/deprecated-dynamic-throughtput-optimization.md) - [dynamicThroughtputOptimizationOverride](https://techdocs.akamai.com/property-mgr/reference/deprecated-dynamic-throughtput-optimization-override.md) - [earlyData](https://techdocs.akamai.com/property-mgr/reference/deprecated-early-data.md) - [earlyDataAdvanced](https://techdocs.akamai.com/property-mgr/reference/deprecated-early-data-advanced.md) - [earlyHints](https://techdocs.akamai.com/property-mgr/reference/deprecated-early-hints.md) - [inputValidation](https://techdocs.akamai.com/property-mgr/reference/deprecated-input-validation.md) - [edgeConnect](https://techdocs.akamai.com/property-mgr/reference/deprecated-edge-connect.md) - [edgeLoadBalancingAdvanced](https://techdocs.akamai.com/property-mgr/reference/deprecated-edge-load-balancing-advanced.md) - [edgeLoadBalancingDataCenter](https://techdocs.akamai.com/property-mgr/reference/deprecated-edge-load-balancing-data-center.md) - [edgeLoadBalancingOrigin](https://techdocs.akamai.com/property-mgr/reference/deprecated-edge-load-balancing-origin.md) - [edgeOriginAuthorization](https://techdocs.akamai.com/property-mgr/reference/deprecated-edge-origin-authorization.md) - [edgeRedirector](https://techdocs.akamai.com/property-mgr/reference/deprecated-edge-redirector.md) - [edgeScape](https://techdocs.akamai.com/property-mgr/reference/deprecated-edge-scape.md) - [edgeSideIncludes](https://techdocs.akamai.com/property-mgr/reference/deprecated-edge-side-includes.md) - [edgeWorker](https://techdocs.akamai.com/property-mgr/reference/deprecated-edge-worker.md) - [enforceMtlsSettings](https://techdocs.akamai.com/property-mgr/reference/deprecated-enforce-mtls-settings.md) - [enhancedAkamaiProtocol](https://techdocs.akamai.com/property-mgr/reference/deprecated-enhanced-akamai-protocol.md) - [enhancedDebug](https://techdocs.akamai.com/property-mgr/reference/deprecated-enhanced-debug.md) - [enhancedProxyDetection](https://techdocs.akamai.com/property-mgr/reference/deprecated-enhanced-proxy-detection.md) - [epdForwardHeaderEnrichment](https://techdocs.akamai.com/property-mgr/reference/deprecated-epd-forward-header-enrichment.md) - [failAction](https://techdocs.akamai.com/property-mgr/reference/deprecated-fail-action.md) - [failoverBotManagerFeatureCompatibility](https://techdocs.akamai.com/property-mgr/reference/deprecated-failover-bot-manager-feature-compatibility.md) - [fastInvalidate](https://techdocs.akamai.com/property-mgr/reference/deprecated-fast-invalidate.md) - [fips](https://techdocs.akamai.com/property-mgr/reference/deprecated-fips.md) - [firstPartyMarketing](https://techdocs.akamai.com/property-mgr/reference/deprecated-first-party-marketing.md) - [firstPartyMarketingPlus](https://techdocs.akamai.com/property-mgr/reference/deprecated-first-party-marketing-plus.md) - [forwardRewrite](https://techdocs.akamai.com/property-mgr/reference/deprecated-forward-rewrite.md) - [g2oheader](https://techdocs.akamai.com/property-mgr/reference/deprecated-g2oheader.md) - [gRPC](https://techdocs.akamai.com/property-mgr/reference/deprecated-g-rpc.md) - [globalRequestNumber](https://techdocs.akamai.com/property-mgr/reference/deprecated-global-request-number.md) - [googleTagGateway](https://techdocs.akamai.com/property-mgr/reference/deprecated-google-tag-gateway.md) - [graphqlCaching](https://techdocs.akamai.com/property-mgr/reference/deprecated-graphql-caching.md) - [gzipResponse](https://techdocs.akamai.com/property-mgr/reference/deprecated-gzip-response.md) - [hdDataAdvanced](https://techdocs.akamai.com/property-mgr/reference/deprecated-hd-data-advanced.md) - [healthDetection](https://techdocs.akamai.com/property-mgr/reference/deprecated-health-detection.md) - [hsafEipBinding](https://techdocs.akamai.com/property-mgr/reference/deprecated-hsaf-eip-binding.md) - [http2](https://techdocs.akamai.com/property-mgr/reference/deprecated-http2.md) - [http3](https://techdocs.akamai.com/property-mgr/reference/deprecated-http3.md) - [httpStrictTransportSecurity](https://techdocs.akamai.com/property-mgr/reference/deprecated-http-strict-transport-security.md) - [httpToHttpsUpgrade](https://techdocs.akamai.com/property-mgr/reference/deprecated-http-to-https-upgrade.md) - [imOverride](https://techdocs.akamai.com/property-mgr/reference/deprecated-im-override.md) - [imageManager](https://techdocs.akamai.com/property-mgr/reference/deprecated-image-manager.md) - [imageManagerVideo](https://techdocs.akamai.com/property-mgr/reference/deprecated-image-manager-video.md) - [include](https://techdocs.akamai.com/property-mgr/reference/deprecated-include.md) - [instant](https://techdocs.akamai.com/property-mgr/reference/deprecated-instant.md) - [instantConfig](https://techdocs.akamai.com/property-mgr/reference/deprecated-instant-config.md) - [largeFileOptimization](https://techdocs.akamai.com/property-mgr/reference/deprecated-large-file-optimization.md) - [largeFileOptimizationAdvanced](https://techdocs.akamai.com/property-mgr/reference/deprecated-large-file-optimization-advanced.md) - [limitBitRate](https://techdocs.akamai.com/property-mgr/reference/deprecated-limit-bit-rate.md) - [localhostLoopbackProtection](https://techdocs.akamai.com/property-mgr/reference/deprecated-localhost-loopback-protection.md) - [logCustom](https://techdocs.akamai.com/property-mgr/reference/deprecated-log-custom.md) - [mPulse](https://techdocs.akamai.com/property-mgr/reference/deprecated-m-pulse.md) - [manifestPersonalization](https://techdocs.akamai.com/property-mgr/reference/deprecated-manifest-personalization.md) - [manifestRerouting](https://techdocs.akamai.com/property-mgr/reference/deprecated-manifest-rerouting.md) - [manualServerPush](https://techdocs.akamai.com/property-mgr/reference/deprecated-manual-server-push.md) - [mediaAcceleration](https://techdocs.akamai.com/property-mgr/reference/deprecated-media-acceleration.md) - [mediaAccelerationQuicOptout](https://techdocs.akamai.com/property-mgr/reference/deprecated-media-acceleration-quic-optout.md) - [mediaClient](https://techdocs.akamai.com/property-mgr/reference/deprecated-media-client.md) - [mediaFileRetrievalOptimization](https://techdocs.akamai.com/property-mgr/reference/deprecated-media-file-retrieval-optimization.md) - [mediaOriginFailover](https://techdocs.akamai.com/property-mgr/reference/deprecated-media-origin-failover.md) - [metadataCaching](https://techdocs.akamai.com/property-mgr/reference/deprecated-metadata-caching.md) - [mobileSdkPerformance](https://techdocs.akamai.com/property-mgr/reference/deprecated-mobile-sdk-performance.md) - [modifyIncomingRequestHeader](https://techdocs.akamai.com/property-mgr/reference/deprecated-modify-incoming-request-header.md) - [modifyIncomingResponseHeader](https://techdocs.akamai.com/property-mgr/reference/deprecated-modify-incoming-response-header.md) - [modifyOutgoingRequestHeader](https://techdocs.akamai.com/property-mgr/reference/deprecated-modify-outgoing-request-header.md) - [modifyOutgoingResponseHeader](https://techdocs.akamai.com/property-mgr/reference/deprecated-modify-outgoing-response-header.md) - [modifyViaHeader](https://techdocs.akamai.com/property-mgr/reference/deprecated-modify-via-header.md) - [mtlsOriginKeystore](https://techdocs.akamai.com/property-mgr/reference/deprecated-mtls-origin-keystore.md) - [optimizeTextStreaming](https://techdocs.akamai.com/property-mgr/reference/deprecated-optimize-text-streaming.md) - [shutr](https://techdocs.akamai.com/property-mgr/reference/deprecated-shutr.md) - [origin](https://techdocs.akamai.com/property-mgr/reference/deprecated-origin.md) - [originCharacteristics](https://techdocs.akamai.com/property-mgr/reference/deprecated-origin-characteristics.md) - [originCharacteristicsWsd](https://techdocs.akamai.com/property-mgr/reference/deprecated-origin-characteristics-wsd.md) - [originFailureRecoveryMethod](https://techdocs.akamai.com/property-mgr/reference/deprecated-origin-failure-recovery-method.md) - [originFailureRecoveryPolicy](https://techdocs.akamai.com/property-mgr/reference/deprecated-origin-failure-recovery-policy.md) - [originIpAcl](https://techdocs.akamai.com/property-mgr/reference/deprecated-origin-ip-acl.md) - [permissionsPolicy](https://techdocs.akamai.com/property-mgr/reference/deprecated-permissions-policy.md) - [persistentClientConnection](https://techdocs.akamai.com/property-mgr/reference/deprecated-persistent-client-connection.md) - [persistentConnection](https://techdocs.akamai.com/property-mgr/reference/deprecated-persistent-connection.md) - [personallyIdentifiableInformation](https://techdocs.akamai.com/property-mgr/reference/deprecated-personally-identifiable-information.md) - [phasedRelease](https://techdocs.akamai.com/property-mgr/reference/deprecated-phased-release.md) - [pqcClientToEdge](https://techdocs.akamai.com/property-mgr/reference/deprecated-pqc-client-to-edge.md) - [pqcOrigin](https://techdocs.akamai.com/property-mgr/reference/deprecated-pqc-origin.md) - [preconnect](https://techdocs.akamai.com/property-mgr/reference/deprecated-preconnect.md) - [predictiveContentDelivery](https://techdocs.akamai.com/property-mgr/reference/deprecated-predictive-content-delivery.md) - [predictivePrefetching](https://techdocs.akamai.com/property-mgr/reference/deprecated-predictive-prefetching.md) - [prefetch](https://techdocs.akamai.com/property-mgr/reference/deprecated-prefetch.md) - [prefetchable](https://techdocs.akamai.com/property-mgr/reference/deprecated-prefetchable.md) - [prefreshCache](https://techdocs.akamai.com/property-mgr/reference/deprecated-prefresh-cache.md) - [quicBeta](https://techdocs.akamai.com/property-mgr/reference/deprecated-quic-beta.md) - [randomSeek](https://techdocs.akamai.com/property-mgr/reference/deprecated-random-seek.md) - [rapid](https://techdocs.akamai.com/property-mgr/reference/deprecated-rapid.md) - [readTimeout](https://techdocs.akamai.com/property-mgr/reference/deprecated-read-timeout.md) - [realUserMonitoring](https://techdocs.akamai.com/property-mgr/reference/deprecated-real-user-monitoring.md) - [redirect](https://techdocs.akamai.com/property-mgr/reference/deprecated-redirect.md) - [redirectplus](https://techdocs.akamai.com/property-mgr/reference/deprecated-redirectplus.md) - [refererChecking](https://techdocs.akamai.com/property-mgr/reference/deprecated-referer-checking.md) - [removeQueryParameter](https://techdocs.akamai.com/property-mgr/reference/deprecated-remove-query-parameter.md) - [removeVary](https://techdocs.akamai.com/property-mgr/reference/deprecated-remove-vary.md) - [report](https://techdocs.akamai.com/property-mgr/reference/deprecated-report.md) - [requestClientHints](https://techdocs.akamai.com/property-mgr/reference/deprecated-request-client-hints.md) - [requestControl](https://techdocs.akamai.com/property-mgr/reference/deprecated-request-control.md) - [requestTypeMarker](https://techdocs.akamai.com/property-mgr/reference/deprecated-request-type-marker.md) - [resourceOptimizer](https://techdocs.akamai.com/property-mgr/reference/deprecated-resource-optimizer.md) - [resourceOptimizerExtendedCompatibility](https://techdocs.akamai.com/property-mgr/reference/deprecated-resource-optimizer-extended-compatibility.md) - [responseCode](https://techdocs.akamai.com/property-mgr/reference/deprecated-response-code.md) - [responseCookie](https://techdocs.akamai.com/property-mgr/reference/deprecated-response-cookie.md) - [restrictObjectCaching](https://techdocs.akamai.com/property-mgr/reference/deprecated-restrict-object-caching.md) - [returnCacheStatus](https://techdocs.akamai.com/property-mgr/reference/deprecated-return-cache-status.md) - [rewriteUrl](https://techdocs.akamai.com/property-mgr/reference/deprecated-rewrite-url.md) - [rumCustom](https://techdocs.akamai.com/property-mgr/reference/deprecated-rum-custom.md) - [saasDefinitions](https://techdocs.akamai.com/property-mgr/reference/deprecated-saas-definitions.md) - [salesForceCommerceCloudClient](https://techdocs.akamai.com/property-mgr/reference/deprecated-sales-force-commerce-cloud-client.md) - [salesForceCommerceCloudProvider](https://techdocs.akamai.com/property-mgr/reference/deprecated-sales-force-commerce-cloud-provider.md) - [salesForceCommerceCloudProviderHostHeader](https://techdocs.akamai.com/property-mgr/reference/deprecated-sales-force-commerce-cloud-provider-host-header.md) - [savePostDcaProcessing](https://techdocs.akamai.com/property-mgr/reference/deprecated-save-post-dca-processing.md) - [scheduleInvalidation](https://techdocs.akamai.com/property-mgr/reference/deprecated-schedule-invalidation.md) - [scriptManagement](https://techdocs.akamai.com/property-mgr/reference/deprecated-script-management.md) - [segmentedContentProtection](https://techdocs.akamai.com/property-mgr/reference/deprecated-segmented-content-protection.md) - [segmentedMediaOptimization](https://techdocs.akamai.com/property-mgr/reference/deprecated-segmented-media-optimization.md) - [segmentedMediaStreamingPrefetch](https://techdocs.akamai.com/property-mgr/reference/deprecated-segmented-media-streaming-prefetch.md) - [setVariable](https://techdocs.akamai.com/property-mgr/reference/deprecated-set-variable.md) - [simulateErrorCode](https://techdocs.akamai.com/property-mgr/reference/deprecated-simulate-error-code.md) - [siteShield](https://techdocs.akamai.com/property-mgr/reference/deprecated-site-shield.md) - [standardTLSMigration](https://techdocs.akamai.com/property-mgr/reference/deprecated-standard-tlsmigration.md) - [standardTLSMigrationOverride](https://techdocs.akamai.com/property-mgr/reference/deprecated-standard-tlsmigration-override.md) - [strictHeaderParsing](https://techdocs.akamai.com/property-mgr/reference/deprecated-strict-header-parsing.md) - [sureRoute](https://techdocs.akamai.com/property-mgr/reference/deprecated-sure-route.md) - [tcpOptimization](https://techdocs.akamai.com/property-mgr/reference/deprecated-tcp-optimization.md) - [teaLeaf](https://techdocs.akamai.com/property-mgr/reference/deprecated-tea-leaf.md) - [tieredDistribution](https://techdocs.akamai.com/property-mgr/reference/deprecated-tiered-distribution.md) - [tieredDistributionAdvanced](https://techdocs.akamai.com/property-mgr/reference/deprecated-tiered-distribution-advanced.md) - [tieredDistributionCustomization](https://techdocs.akamai.com/property-mgr/reference/deprecated-tiered-distribution-customization.md) - [timeout](https://techdocs.akamai.com/property-mgr/reference/deprecated-timeout.md) - [uidConfiguration](https://techdocs.akamai.com/property-mgr/reference/deprecated-uid-configuration.md) - [validateEntityTag](https://techdocs.akamai.com/property-mgr/reference/deprecated-validate-entity-tag.md) - [verifyTokenAuthorization](https://techdocs.akamai.com/property-mgr/reference/deprecated-verify-token-authorization.md) - [visitorPrioritization](https://techdocs.akamai.com/property-mgr/reference/deprecated-visitor-prioritization.md) - [visitorPrioritizationQueueIt](https://techdocs.akamai.com/property-mgr/reference/deprecated-visitor-prioritization-queue-it.md) - [watermarking](https://techdocs.akamai.com/property-mgr/reference/deprecated-watermarking.md) - [webApplicationFirewall](https://techdocs.akamai.com/property-mgr/reference/deprecated-web-application-firewall.md) - [webSockets](https://techdocs.akamai.com/property-mgr/reference/deprecated-web-sockets.md) - [webdav](https://techdocs.akamai.com/property-mgr/reference/deprecated-webdav.md) - [v2026-05-05 criteria](https://techdocs.akamai.com/property-mgr/reference/deprecated-criteria.md) - [advancedImMatch](https://techdocs.akamai.com/property-mgr/reference/deprecated-advanced-im-match.md) - [bucket](https://techdocs.akamai.com/property-mgr/reference/deprecated-bucket.md) - [cacheability](https://techdocs.akamai.com/property-mgr/reference/deprecated-cacheability.md) - [chinaCdnRegion](https://techdocs.akamai.com/property-mgr/reference/deprecated-china-cdn-region.md) - [clientCertificate](https://techdocs.akamai.com/property-mgr/reference/deprecated-client-certificate.md) - [clientIp](https://techdocs.akamai.com/property-mgr/reference/deprecated-client-ip.md) - [clientIpVersion](https://techdocs.akamai.com/property-mgr/reference/deprecated-client-ip-version.md) - [cloudletsOrigin](https://techdocs.akamai.com/property-mgr/reference/deprecated-cloudlets-origin.md) - [contentDeliveryNetwork](https://techdocs.akamai.com/property-mgr/reference/deprecated-content-delivery-network.md) - [contentType](https://techdocs.akamai.com/property-mgr/reference/deprecated-content-type.md) - [debugMode](https://techdocs.akamai.com/property-mgr/reference/deprecated-debug-mode.md) - [deviceCharacteristic](https://techdocs.akamai.com/property-mgr/reference/deprecated-device-characteristic.md) - [edgeWorkersFailure](https://techdocs.akamai.com/property-mgr/reference/deprecated-edge-workers-failure.md) - [fileExtension](https://techdocs.akamai.com/property-mgr/reference/deprecated-file-extension.md) - [filename](https://techdocs.akamai.com/property-mgr/reference/deprecated-filename.md) - [hostname](https://techdocs.akamai.com/property-mgr/reference/deprecated-hostname.md) - [matchAdvanced](https://techdocs.akamai.com/property-mgr/reference/deprecated-match-advanced.md) - [matchCpCode](https://techdocs.akamai.com/property-mgr/reference/deprecated-match-cp-code.md) - [matchResponseCode](https://techdocs.akamai.com/property-mgr/reference/deprecated-match-response-code.md) - [matchVariable](https://techdocs.akamai.com/property-mgr/reference/deprecated-match-variable.md) - [metadataStage](https://techdocs.akamai.com/property-mgr/reference/deprecated-metadata-stage.md) - [originTimeout](https://techdocs.akamai.com/property-mgr/reference/deprecated-origin-timeout.md) - [path](https://techdocs.akamai.com/property-mgr/reference/deprecated-path.md) - [queryStringParameter](https://techdocs.akamai.com/property-mgr/reference/deprecated-query-string-parameter.md) - [random](https://techdocs.akamai.com/property-mgr/reference/deprecated-random.md) - [recoveryConfig](https://techdocs.akamai.com/property-mgr/reference/deprecated-recovery-config.md) - [regularExpression](https://techdocs.akamai.com/property-mgr/reference/deprecated-regular-expression.md) - [requestCookie](https://techdocs.akamai.com/property-mgr/reference/deprecated-request-cookie.md) - [requestHeader](https://techdocs.akamai.com/property-mgr/reference/deprecated-request-header.md) - [requestMethod](https://techdocs.akamai.com/property-mgr/reference/deprecated-request-method.md) - [requestProtocol](https://techdocs.akamai.com/property-mgr/reference/deprecated-request-protocol.md) - [requestType](https://techdocs.akamai.com/property-mgr/reference/deprecated-request-type.md) - [responseHeader](https://techdocs.akamai.com/property-mgr/reference/deprecated-response-header.md) - [serverLocation](https://techdocs.akamai.com/property-mgr/reference/deprecated-server-location.md) - [time](https://techdocs.akamai.com/property-mgr/reference/deprecated-time.md) - [tokenAuthorization](https://techdocs.akamai.com/property-mgr/reference/deprecated-token-authorization.md) - [userAgent](https://techdocs.akamai.com/property-mgr/reference/deprecated-user-agent.md) - [userLocation](https://techdocs.akamai.com/property-mgr/reference/deprecated-user-location.md) - [userNetwork](https://techdocs.akamai.com/property-mgr/reference/deprecated-user-network.md) - [variableError](https://techdocs.akamai.com/property-mgr/reference/deprecated-variable-error.md) - [List groups](https://techdocs.akamai.com/property-mgr/reference/get-groups.md): You need information about the prevailing group to access most PAPI interfaces. This operation provides a read-only list of groups, which may contain properties. This operation provides a flat list of groups, along with `parentGroupId` information to structure them as a hierarchy. Each group also lists any available contracts that enable property features, but not which group contains a given property. Use the [Identity and Access Management API](https://techdocs.akamai.com/iam-api/reference/api) to assign properties to groups, and modify the group hierarchy. - [Create a new edge hostname](https://techdocs.akamai.com/property-mgr/reference/post-edgehostnames.md): **Note:** You can skip this operation if you're using a Default Domain Validation (DV) certificate, which automatically creates an edge hostname upon activation. This POST operation creates a new edge hostname. As detailed in the sections below, you can use three approaches to secure new edge hostnames: Standard TLS, Enhanced TLS, or a Shared Certificate. You can [assign a use case](ref:modify-property-hostnames) mapping profile to optimize the hostname to serve specific types of traffic. Once the edge hostname is active, you can [Update a property's hostnames](ref:put-property-version-hostnames) to assign it to a hostname on a property. After you [activate a property](ref:post-property-activations), modifying your DNS to map the property hostname to the edge hostname ultimately enables traffic on the property. For details, see [Enable traffic for a new hostname](ref:modify-property-hostnames). Use the [Edge Hostname API](https://techdocs.akamai.com/edge-hostnames/reference/get-edge-hostname-certificate) (HAPI) to modify edge hostnames, or delete any that aren't currently assigned to an active property configuration. - [List edge hostnames](https://techdocs.akamai.com/property-mgr/reference/get-edgehostnames.md): This lists all edge hostnames available under a contract. To assign any of these hostnames to a property, run [Update a property's hostnames](ref:put-property-version-hostnames). Use the [Edge Hostname API](https://techdocs.akamai.com/edge-hostnames/reference/get-edge-hostname-certificate) (HAPI) to modify edge hostnames, or delete any that aren't currently assigned to an active property configuration. - [Get an edge hostname](https://techdocs.akamai.com/property-mgr/reference/get-edgehostname.md): This polls the state of an edge hostname, typically after [creating a new edge hostname](ref:post-edgehostnames). The response tells you whether the CNAME has been fully distributed across the network. If the hostname's `status` is `ACTIVE`, the process is complete. Until then, you typically see values of `ZONE1`, `ZONE2`, `ZONE3`, or simply `PENDING`. - [List products](https://techdocs.akamai.com/property-mgr/reference/get-products.md): This operation lists the set of products that are available under a given contract. You need a product identifier to create new edge hostnames, CP codes, or properties. The assigned product determines the supported set of rule behaviors available within a property. - [List use cases](https://techdocs.akamai.com/property-mgr/reference/get-product-mapping-use-cases.md): For a given product, this lists Akamai-provided use case scenarios. Use cases help optimally map different types of traffic across the Akamai edge network. Optionally run this operation to gather values before [creating a new edge hostname](ref:post-edgehostnames). - [List contracts](https://techdocs.akamai.com/property-mgr/reference/get-contracts.md): You need information about the prevailing contract to access most PAPI interfaces. This operation provides a read-only list of contract names and identifiers. The response provides context on the overall account that enables each contract and keys your API credentials, but you don't need it to access any PAPI objects. - [Create a new CP code](https://techdocs.akamai.com/property-mgr/reference/post-cpcodes.md): **Note:** You can skip this operation if you want to use a default Content Provider code that's been generated for your contract. To use a default value, make sure in the [`cpCode`](ref:latest-cp-code) behavior you specify `enableDefaultContentProviderCode: true`. To create a new CP code, you need to associate it with a product. You can assign any CP code within a property's rule tree as detailed in the [Rule Trees](ref:rule-trees) section. Make sure the CP code's `productId` value matches the one assigned to the properties that invoke your CP code, otherwise you may get a warning about problems this may cause in traffic reports. To use the newly created CP code, make sure in the [`cpCode`](ref:latest-cp-code) behavior you specify `enableDefaultContentProviderCode: false` and provide the `value.id`. To view or update certain CP code data, such as name, time zone, and purgeability, use the [CP Codes and Reporting Groups API](https://techdocs.akamai.com/cp-codes/reference/api). You can write `contractid` and `groupId` data only on the initial POST operation. They're read-only in subsequent [PUT](https://techdocs.akamai.com/cp-codes/reference/put-cpcode) operations. To reassign a CP code's contract or group, contact your Akamai representative for help. - [List CP codes](https://techdocs.akamai.com/property-mgr/reference/get-cpcodes.md): This operation lists CP codes available within your contract and group pairing. You assign CP codes to a property within its rule tree. 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](https://techdocs.akamai.com/cp-codes/reference/get-cpcodes). CP codes include information about their product assignment. When [creating a new property](ref:post-properties), you need to apply the same product you specified for the assigned CP code. To view or update certain CP code data, such as name, time zone, and purgeability, use the [CP Codes and Reporting Groups API](https://techdocs.akamai.com/cp-codes/reference/api). - [Get a CP code](https://techdocs.akamai.com/property-mgr/reference/get-cpcode.md): This operation gets details about a CP code. To view or update certain CP code data, such as name, time zone, and purgeability, use the [CP Codes and Reporting Groups API](https://techdocs.akamai.com/cp-codes/reference/api). - [Create or clone an include](https://techdocs.akamai.com/property-mgr/reference/post-includes.md): __Limited availability__ This operation either creates a new include from scratch or bases one on another include's rule tree. Version 1 of a new include is created automatically. - [List includes](https://techdocs.akamai.com/property-mgr/reference/get-includes.md): __Limited availability__ This operation lists includes available for the current contract and group. Use optional query parameters to only show includes that were modified within a specified time range or on a selected network. If you specify the `modifiedSince` parameter, `contractId` and `groupId` become optional. If you don't identify a contract and group, the operation lists all includes you have access to, modified within a specified time range. - [Validate an include](https://techdocs.akamai.com/property-mgr/reference/get-include-validation.md): __Limited availability__ Gets the results of an include validation against the specified parent property version that references the include. - [Get an include](https://techdocs.akamai.com/property-mgr/reference/get-include.md): __Limited availability__ This operation gets a specific include. You can call this operation by specifying any of the `includeId` members from a [list of includes](ref:get-includes), or by running a GET on the `includeLink` response when [creating a new include](ref:post-includes). - [Remove an include](https://techdocs.akamai.com/property-mgr/reference/delete-include.md): __Limited availability__ Removes a specific include, which you can only do if none of its versions are currently active. A successful DELETE results in a 200 response and a confirmation message. Attempting to delete an active include results in a 500 error. Attempting to delete an unknown include results in a 404 error. - [List parent properties](https://techdocs.akamai.com/property-mgr/reference/get-include-parents.md): __Limited availability__ Lists all active properties that reference a specific include. Combine optional query parameters to paginate, sort, and filter the results. Specify any `includeId` you get from a [list of includes](ref:get-includes). - [Activate or deactivate an include](https://techdocs.akamai.com/property-mgr/reference/post-include-activation.md): __Limited availability__ This operation creates a new include activation, which deactivates any current activation. After a necessary delay, this activates your version's rule tree modifying how your edge content responds to end-user requests. > **Note:** To reduce errors, avoid calling PAPI with separate clients on the same data. Avoid frequently polling status values. Instead, progressively increase the delay between calls. - [List include's activations](https://techdocs.akamai.com/property-mgr/reference/get-include-activations.md): __Limited availability__ This lists all activations for all versions of an include, on both production and staging networks. - [Get an include activation](https://techdocs.akamai.com/property-mgr/reference/get-include-activation.md): __Limited availability__ Gets details about an activation. The response also shows the results of a validation against the rule trees of active parent properties that reference the include. While you can ignore any warnings that indicate non-blocking, logical inconsistencies, you need to resolve all errors to activate an include. You typically get a single activation from an `activationLink` when [launching a new activation](ref:post-include-activation), and you follow up to poll its `status`. For activations whose `status` is `PENDING`, a `Retry-After` header provides an estimate for when it's likely to go live. > **Note:** To reduce errors, avoid calling PAPI with separate clients on the same data. Avoid frequently polling status values. Instead, progressively increase the delay between calls. - [Cancel an include's pending activation](https://techdocs.akamai.com/property-mgr/reference/delete-include-activation.md): __Limited availability__ If you detect a problem with an include version while its activation is still `PENDING`, use this operation to cancel it. Make a DELETE request on the `activationLink` you get from the [Activate an include](ref:post-include-activation) operation's response. Once you DELETE the activation, it no longer appears in the [list of activations](ref:get-include-activations), but you can still [access it individually](ref:get-include-activation). - [Create a new include version](https://techdocs.akamai.com/property-mgr/reference/post-include-versions.md): __Limited availability__ Create a new include version based on any previous version. All data from the `createFromVersion` populates the new version. Specify `createFromVersionEtag` if you want to ensure you're creating from a version that hasn't changed since you fetched it. - [List include versions](https://techdocs.akamai.com/property-mgr/reference/get-include-versions.md): __Limited availability__ Lists the include's versions, with results limited to the 500 most recent versions. Optionally paginate the results. Each include version indicates an activation status on different networks, and an `etag` digest useful when [cloning the include](ref:post-includes). - [Get the latest include version](https://techdocs.akamai.com/property-mgr/reference/get-latest-include-version.md): __Limited availability__ This operation provides either the latest include version overall, or the latest one active on the production or staging networks. By default, the response yields the include version with the highest number. Specifying an `activatedOn` of `STAGING` or `PRODUCTION` yields the version that's currently active on either network. - [Get an include version](https://techdocs.akamai.com/property-mgr/reference/get-include-version.md): __Limited availability__ This polls the state of a specific include version, for example to check its activation status. When specifying `Accept: text/xml`, this operation provides the Akamai _metadata_ configuration data that's distributed to edge servers when you activate an include version. This XML data encapsulates the include version's component rules and is available on a read-only basis. Contact your Akamai representative if you need help interpreting it. - [List available behaviors for an include](https://techdocs.akamai.com/property-mgr/reference/get-include-available-behaviors.md): __Limited availability__ Lists the set of [behaviors](ref:ga-behaviors) you may apply within an include version's rules. The available set depends on the product under which you created the property and any additional modules enabled under your account. - [List available criteria for an include](https://techdocs.akamai.com/property-mgr/reference/get-include-available-criteria.md): __Limited availability__ Lists the set of [criteria](ref:ga-criteria) you may apply within an include version's rules. The available set depends on the product under which you created the property and any additional modules enabled under your account. - [Get an include's rule tree](https://techdocs.akamai.com/property-mgr/reference/get-include-version-rules.md): __Limited availability__ Gets the entire rule tree for an include version. See the [Rule Trees](ref:rule-trees) section for details on the response object's structure. Also use this operation to update from one rule format to another more recent version, incrementing the assigned set of features. See [Update rules to a newer set of features](ref:rule-format-schemas#update-rules-to-a-newer-set-of-features). - [Update an include's rule tree](https://techdocs.akamai.com/property-mgr/reference/put-include-version-rules.md): __Limited availability__ To write a rule tree to an include version, make a PUT request to the same resource as the GET request that reads it, passing in the rule object in the body of the request. See the [Rule Trees](ref:rule-trees) section for details on the rule tree's structure. Use this operation also to [freeze a set of rules](ref:rule-format-schemas#freeze-a-feature-set-for-a-rule-tree) to a rule format version to ensure no change in a deployed activation's behavior. Set the `validateRules` query parameter to `false` to bypass a set of validation tests that may significantly slow this operation's execution time. See [Validation best practices](ref:validation-best-practices) for guidance on when to defer validation. See [Rule tree errors and warnings](ref:rule-tree-errors-and-warnings) and [Validation errors](ref:validation-errors) for information on how validation data is embedded within the response object. - [Patch an include's rule tree](https://techdocs.akamai.com/property-mgr/reference/patch-include-version-rules.md): __Limited availability__ Selectively modify a rule tree using [JSON patch](http://jsonpatch.com) syntax. Set the `validateRules` query parameter to `false` to bypass a set of validation tests that may significantly slow this operation's execution time. See [Validation best practices](ref:validation-best-practices) for guidance on when to defer validation. See [Rule tree errors and warnings](ref:rule-tree-errors-and-warnings) and [Validation errors](ref:validation-errors) for information on how validation data is embedded within the response object. - [Get a digest for an include's rule tree](https://techdocs.akamai.com/property-mgr/reference/head-include-version-rules.md): __Limited availability__ Gets the rule tree's ETag without the rule tree object. Ordinarily when you [get a rule tree](ref:get-include-version-rules), the response includes a large rule tree object. As discussed in [Concurrency control](ref:concurrency-control), it includes a top-level `etag` data digest to use when [writing back the data](ref:put-include-version-rules). Use this operation if you simply want to get the `ETag` as a header without the data. - [List hostnames for an account](https://techdocs.akamai.com/property-mgr/reference/get-hostnames.md): This operation lists active property hostnames for all properties available in an account. Use the optional query parameters to paginate, sort, and filter the results. You can nest and combine filters to obtain desired results. To view paginated results, use the response's `nextLink` and `previousLink`. - [Generate certificate domain validation challenges](https://techdocs.akamai.com/property-mgr/reference/post-certificate-challenges.md): If you're using Default Domain Validation (DV) certificates, you can generate the domain validation challenges ahead of setting hostnames for your property. Ordinarily, you get the challenges when you [add hostnames to a property version](ref:patch-property-version-hostnames) or [add hostnames to a property's hostname bucket](ref:patch-property-hostnames). This operation returns the `validationCname` object that you use to validate the certificate's domain. For each requested property hostname, create a new CNAME record in the DNS configuration and map the object's `hostname` to the `target`. **Note**: If you're using a new account, first register it on the Akamai network by activating any property version on either staging or production. Otherwise, your attempts to generate certificates will fail with a [403](ref:403) error. - [Get audit history](https://techdocs.akamai.com/property-mgr/reference/get-hostname-audit-history.md): Gets a detailed record of all modifications made to a property hostname. - [Create or clone a property](https://techdocs.akamai.com/property-mgr/reference/post-properties.md): This operation either creates a new property from scratch or bases one on another property's rule tree and optionally its set of assigned hostnames. Version 1 of a new property is created automatically. PAPI's ability to create and clone new properties means that you can design a system of rule templates targeted to specific domains, rather than maintain a single set of rules with conditional logic for your full range of domains. Maintaining properties manually within the Control Center interface limited you to that more consolidated approach, but you can deploy rules more efficiently using PAPI. In either case, PAPI makes it much easier for you to support a large, flexible set of domains. - [List properties](https://techdocs.akamai.com/property-mgr/reference/get-properties.md): This operation lists properties available for the current contract and group. Use optional query parameters to only show properties that were modified within a specified time range or on a selected network. If you specify the `modifiedSince` parameter, `contractId` and `groupId` become optional. If you don't identify a contract and group, the operation lists all properties you have access to, modified within a specified time range. - [Get a property](https://techdocs.akamai.com/property-mgr/reference/get-property.md): This operation gets a specific property. You can call this operation by specifying any of the `propertyId` members from a [list of properties](ref:get-properties), or by running a GET on the `propertyLink` response when [creating a new property](ref:post-properties). - [Remove a property](https://techdocs.akamai.com/property-mgr/reference/delete-property.md): Removes a specific property, which you can only do if none of its versions are currently active. Activating another property with the same set of hostnames automatically triggers a deactivation on the targeted property. See [Create a new activation](ref:post-property-activations) for details. A successful DELETE results in a 200 response with the confirmation message. Attempting to delete an active property results in a 500 error. Attempting to delete an unknown property results in a 404 error. - [Activate or deactivate a property](https://techdocs.akamai.com/property-mgr/reference/post-property-activations.md): This operation creates a new property activation, which deactivates any currently active version. After a necessary delay, this activates your property version's rule tree and set of hostnames across Akamai's network of edge servers, modifying how your edge content responds to end-user requests. If your account is enabled for mandatory domain validation, you need to prove ownership of the domains you set up as property hostnames, before activating the property. You can either pre-validate your domains by [generating validation challenges](ref:post-domain-ownership-challenges) or use the challenges you get while [adding](ref:patch-property-version-hostnames), [listing](ref:get-property-version-hostnames), or [updating](ref:put-property-version-hostnames) your property version hostnames. [Learn more](https://techdocs.akamai.com/domain-validation/docs/welcome). > **Note:** To reduce errors, avoid calling PAPI with separate clients on the same data. Avoid frequently polling status values. Instead, progressively increase the delay between calls. If there's a problem with the property you activated, you may have the option to fall back to the previous version. To build the request object, go to the `activationLink` from the activation's response and note down the `fallbackVersion` value. Within an hour of activating, POST another activation with `propertyVersion` set to the version you noted down and `useFastFallback` set to `true`. This disables the current activation and falls back to the specified version. A fallback takes a few seconds, but the option is available only if there have been no changes to the set of property hostnames, as indicated by `canFastFallback`. - [List property's activations](https://techdocs.akamai.com/property-mgr/reference/get-property-activations.md): This lists all activations for all versions of a property, on both production and staging networks. - [Get a property activation](https://techdocs.akamai.com/property-mgr/reference/get-property-activation.md): Gets details about an activation. You typically get a single activation from an `activationLink` when [launching a new activation](ref:post-property-activations) and following up to poll its `status`. For activations whose `status` is `PENDING`, a `Retry-After` header provides an estimate for when it's likely to change. > **Note:** To reduce errors, avoid calling PAPI with separate clients on the same data. Avoid frequently polling status values. Instead, progressively increase the delay between calls. - [Get property activation status details](https://techdocs.akamai.com/property-mgr/reference/get-property-activation-status.md): Gets details about an activation. You typically get a single activation from an `activationLink` when [launching a new activation](ref:post-property-activations) and following up to poll its `status`. For activations whose `status` is `PENDING`, a `Retry-After` header provides an estimate for when it's likely to change. > **Note:** To reduce errors, avoid calling this operation with separate clients on the same data. Avoid frequently polling status values. Instead, progressively increase the delay between calls. - [Cancel a property's pending activation](https://techdocs.akamai.com/property-mgr/reference/delete-property-activation.md): If you detect a problem with a property version while its activation is still `PENDING`, use this operation to cancel it. Make a DELETE request on the `activationLink` you get from the [Activate a property](ref:post-property-activations) operation's response. Once you DELETE the activation, it no longer appears in the [list of activations](ref:get-property-activations), but you can still [access it individually](ref:get-property-activation). If there are unexpected problems with an activation that goes live before you're able to cancel it, you often have a one-hour window to quickly fall back to a previous activation. See [Activate or deactivate a property](ref:post-property-activations) for details. - [List property hostname activations](https://techdocs.akamai.com/property-mgr/reference/get-property-hostname-activations.md): For a property with `useHostnameBucket` set to `true` at [creation](ref:post-properties), this lists the activations for all hostnames in the property's hostname bucket, on both production and staging networks. To view paginated results, use the response's `nextLink` and `previousLink`. - [Get a property hostname activation](https://techdocs.akamai.com/property-mgr/reference/get-property-hostname-activation.md): For a property with `useHostnameBucket` set to `true` at [creation](ref:post-properties), this operation gets details about a specific property hostname activation. You typically get a single activation from an `activationLink` when [launching a new property hostname activation](ref:patch-property-hostnames) and following up to poll its `status`. For property hostname activations whose `status` is `PENDING`, a `Retry-After` header provides an estimate for when it's likely to change. - [Cancel a pending property hostname activation](https://techdocs.akamai.com/property-mgr/reference/delete-property-hostname-activations.md): For a property with `useHostnameBucket` set to `true` [when created](ref:post-properties), if you detect a problem with a property hostname while its activation is still `PENDING`, use this operation to cancel it. Make a DELETE request on the `activationLink` you get from the [Add or remove hostnames for a property](ref:patch-property-hostnames) operation's response. Once you DELETE the activation, it no longer appears in the [list of activations](ref:get-property-hostname-activations), but you can still [access it individually](ref:get-property-hostname-activation). - [Add or remove hostnames for a property's hostname bucket](https://techdocs.akamai.com/property-mgr/reference/patch-property-hostnames.md): For a property with `useHostnameBucket` set to `true` [when created](ref:post-properties), this operation adds or removes up to 1000 property hostnames without incrementing the property version. Changes automatically activate on the selected network. If a property doesn't have hostname buckets enabled, this operation returns a [403](ref:403) error. If another activation is in progress, whether it's a hostname activation or a property version activation, the operation fails with a [409](ref:409) error. Once you perform this operation, it blocks subsequent requests until all the property hostnames are active. Note that to build the request body, you need to first obtain the `edgeHostnameId` either from an existing edge hostname or a new one you create by running the [Create a new edge hostname](ref:post-edgehostnames) operation. If your account is enabled for mandatory domain validation, you need to prove ownership of the domains you set up as property hostnames. Pre-validate your domains before adding them to the bucket. You can either use PAPI to [generate validation challenges](ref:post-domain-ownership-challenges) or pre-validate your domains in the [Domain Ownership Manager](https://techdocs.akamai.com/domain-validation/docs/welcome) application. **Note**: If you're using a new account, first register it on the Akamai network by activating any property version on either staging or production. Otherwise, your attempts to create or specify certificates will fail with a [403](ref:403) error. - [List hostnames for a property](https://techdocs.akamai.com/property-mgr/reference/get-property-hostnames.md): This operation lists active property hostnames assigned to a specific property. Use the optional query parameters to paginate, sort, and filter the results. You can nest and combine filters to obtain desired results. To view paginated results, use the response's `nextLink` and `previousLink`. You can call this operation by specifying any of the `propertyId` members from a [list of properties](ref:get-properties), or by running a GET on the `propertyLink` response when [creating a new property](ref:post-properties). - [Get property hostnames diff](https://techdocs.akamai.com/property-mgr/reference/get-property-hostnames-diff.md): This operation lists active property hostnames whose details differ between the staging and production networks. Optionally paginate the results. You can run this operation by specifying any of the `propertyId` members from a [list of properties](ref:get-properties), or by running a GET on the `propertyLink` response when [creating a new property](ref:post-properties). - [Regenerate domain validation challenges](https://techdocs.akamai.com/property-mgr/reference/post-property-hostnames-certificate-regenerate.md): __Limited availability__ Regenerate certificate domain validation challenges that are near their expiration date. - [Resume certificate domain validation](https://techdocs.akamai.com/property-mgr/reference/post-property-hostnames-certificate-proceed.md): __Limited availability__ If you're using Default Domain Validation (DV) certificates, some domains validated using either manual HTTP or manual DNS method can return the `PAUSED_AWAITING_PROCEED` authorization status in the [GET response](ref:get-property-hostnames). Run this operation to resume the validation process for these domains. - [Create a new property version](https://techdocs.akamai.com/property-mgr/reference/post-property-versions.md): Create a new property version based on any previous version. All data from the `createFromVersion` populates the new version, including its rules and hostnames. Specify `createFromVersionEtag` if you want to ensure you're creating from a version that hasn't changed since you fetched it. - [List property versions](https://techdocs.akamai.com/property-mgr/reference/get-property-versions.md): Lists the property's versions, with results limited to the 500 most recent versions. Optionally paginate the results. Each property version indicates activation status on different networks, and an `etag` digest useful when [cloning the property](ref:post-properties). - [Get the latest property version](https://techdocs.akamai.com/property-mgr/reference/get-latest-property-version.md): This operation provides either the latest property version overall, or the latest one active on the production or staging networks. By default, the response yields the property version with the highest number. Specifying an `activatedOn` of `STAGING` or `PRODUCTION` yields the version that's currently active on either network. - [Get a property version](https://techdocs.akamai.com/property-mgr/reference/get-property-version.md): This polls the state of a specific property version, for example to check its activation status. When specifying `Accept: text/xml`, this operation provides the Akamai _metadata_ configuration data that's distributed to edge servers when you activate a property version. This XML data encapsulates the property version's component rules and hostnames, and is available on a read-only basis. Contact your Akamai representative if you need help interpreting it. - [List available behaviors for a property](https://techdocs.akamai.com/property-mgr/reference/get-available-behaviors.md): Lists the set of [behaviors](ref:ga-behaviors) you may apply within a property version's rules. The available set depends on the product under which you created the property and any additional modules enabled under your account. - [List available criteria for a property](https://techdocs.akamai.com/property-mgr/reference/get-available-criteria.md): Lists the set of [criteria](ref:ga-criteria) you may apply within a property version's rules. The available set depends on the product under which you created the property and any additional modules enabled under your account. - [List hostnames for a property version](https://techdocs.akamai.com/property-mgr/reference/get-property-version-hostnames.md): List all hostnames whose requests are handled by the rules in this property version. - [Update hostnames for a property version](https://techdocs.akamai.com/property-mgr/reference/put-property-version-hostnames.md): Modify the set of hostnames for a property version. For each hostname entry, set headers indicating their [limits](ref:rate-and-resource-limiting). If your account is enabled for mandatory domain validation, you need to prove ownership of the domains you set up as property hostnames, before activating the property. You can either pre-validate your domains by [generating validation challenges](ref:post-domain-ownership-challenges) or use the challenges you get while [adding](ref:patch-property-version-hostnames), [listing](ref:get-property-version-hostnames), or updating your property version hostnames. [Learn more](https://techdocs.akamai.com/domain-validation/docs/welcome). **Note**: If you're using a new account, first register it on the Akamai network by activating any property version on either staging or production. Otherwise, your attempts to create or specify certificates will fail with a [403](ref:403) error. - [Add or remove hostnames for a property version](https://techdocs.akamai.com/property-mgr/reference/patch-property-version-hostnames.md): Modify the set of hostnames for a property version. For new entries, specify an `add` array with a `cnameFrom` set to the hostname your end users see as `Host` headers. In either `cnameTo` or `edgeHostnameId`, specify an existing edge hostname you want to redirect your hostname to. If you're using Default Domain Validation (DV) certificates, you can set the `cnameTo` to an edge hostname that doesn't exist yet, and PAPI creates it automatically when you activate the property version. To remove a hostname, specify a `remove` array with the address of the hostname you don't want to use with this property version anymore. If you remove an edge hostname from an active property configuration, use the [Edge Hostname API](https://techdocs.akamai.com/edge-hostnames/reference/delete-edgehostname) (HAPI) to delete it entirely. If you modify hostnames with Default DV certificates, the response includes additional `X-Limit-Default-Certs-Per-Contract-Limit` and `X-Limit-Default-Certs-Per-Contract-Remaining` headers indicating their [limits](ref:rate-and-resource-limiting). If your account is enabled for mandatory domain validation, you need to prove ownership of the domains you set up as property hostnames, before activating the property. You can either pre-validate your domains by [generating validation challenges](ref:post-domain-ownership-challenges) or use the challenges you get while adding, [listing](ref:get-property-version-hostnames), or [updating](ref:put-property-version-hostnames) your property version hostnames. [Learn more](https://techdocs.akamai.com/domain-validation/docs/welcome). **Note**: If you're using a new account, first register it on the Akamai network by activating any property version on either staging or production. Otherwise, your attempts to create or specify certificates will fail with a [403](ref:403) error. - [List property's includes](https://techdocs.akamai.com/property-mgr/reference/get-property-version-includes.md): __Limited availability__ Lists the set of includes referenced in the property version's rule tree. - [Get a property's rule tree](https://techdocs.akamai.com/property-mgr/reference/get-property-version-rules.md): Gets the entire rule tree for a property version. See the [Rule Trees](ref:rule-trees) section for details on the response object's structure. Also use this operation to: - Update a set of features to their most recent version in the `latest` rule format. See [Dynamic rule updates](ref:dynamic-rule-format-updates#upgrade-from-a-frozen-rule-format-to-latest) for more details. - Update from one frozen rule format to a more recent version, incrementing the assigned set of features. See [Update rules to a newer set of features](ref:rule-format-schemas#update-rules-to-a-newer-set-of-features). If the response includes any [validation errors](ref:validation-errors), you need to resolve them before activating the property version. - [Update a property's rule tree](https://techdocs.akamai.com/property-mgr/reference/put-property-version-rules.md): To write a rule tree to a property version, make a PUT request to the same resource as the GET request that reads it. Pass in the rule object in the body of the request. See the [Rule Trees](ref:rule-trees) section for details on the rule tree's structure. With the `updateRules` query parameter defaulting to `true`, you can continuously use the `latest` rule format and keep working with your current rule tree without causing new validation errors as Akamai dynamically modifies catalog options. See [Dynamic rule updates](ref:dynamic-rule-format-updates#upgrade-from-a-frozen-rule-format-to-latest) for more details. If you prefer to use a dated rule format version over `latest`, you can also use this operation to [Freeze a set of rules](ref:rule-format-schemas#freeze-a-feature-set-for-a-rule-tree) to a rule format version. Set the `validateRules` query parameter to `false` to bypass a set of validation tests that may significantly slow this operation's execution time. See [Validation best practices](ref:validation-best-practices) for guidance on when to defer validation. If the [GET response](ref:get-property-version-rules) yields any rule tree errors, you need to fix them before activating. This PUT operation saves a rule tree even if it contains errors that block the property activation. See [Rule tree errors and warnings](ref:rule-tree-errors-and-warnings) and [Validation errors](ref:validation-errors) for information on how validation data is embedded within the response object. - [Patch a property's rule tree](https://techdocs.akamai.com/property-mgr/reference/patch-property-version-rules.md): Selectively modify a rule tree using [JSON patch](http://jsonpatch.com) syntax. As a component of the larger [Bulk patch a set of properties](ref:post-bulk-patch), this operation patches an individual rule tree. See [Bulk Search and Update](ref:bulk-search-and-update) for more information. With the `updateRules` query parameter defaulting to `true`, you can continuously use the `latest` rule format and keep working with your current rule tree without causing new validation errors as Akamai dynamically modifies catalog options. See [Dynamic rule updates](ref:dynamic-rule-format-updates#upgrade-from-a-frozen-rule-format-to-latest) for more details. To bypass a set of validation tests that may significantly slow this operation's execution time, set the `validateRules` query parameter to `false` or `validateMode` to `fast`. See [Validation best practices](ref:validation-best-practices) for guidance on when to defer validation. See [Rule tree errors and warnings](ref:rule-tree-errors-and-warnings) and [Validation errors](ref:validation-errors) for information on how validation data is embedded within the response object. - [Get a digest for a property's rule tree](https://techdocs.akamai.com/property-mgr/reference/head-property-version-rules.md): Gets the rule tree's ETag without the rule tree object. Ordinarily when you [get a rule tree](ref:get-property-version-rules), the response includes a large rule tree object. As discussed in [Concurrency control](ref:concurrency-control), it includes a top-level `etag` data digest to use when [writing back the data](ref:put-property-version-rules). Use this operation if you simply want to get the `ETag` as a header without the data. - [List custom behaviors](https://techdocs.akamai.com/property-mgr/reference/get-custom-behaviors.md): Lists the set of custom XML metadata behaviors configured for you by Akamai representatives. Referencing the relevant `behaviorId` from a [`customBehavior`](ref:latest-custom-behavior) within the rule tree injects the custom XML within the rest of the rule tree's metadata XML. See [Custom behaviors and overrides](ref:custom-behaviors-and-overrides) for guidance on custom overrides. - [Get a custom behavior](https://techdocs.akamai.com/property-mgr/reference/get-custom-behavior.md): Get information for a single custom behavior. Use this operation if you want to examine the custom behavior's XML metadata source. - [List custom overrides](https://techdocs.akamai.com/property-mgr/reference/get-custom-overrides.md): Lists the set of custom XML metadata overrides configured for you by Akamai representatives. Referencing the relevant `overrideId` from a `customOverride` object makes the custom XML append to the rest of the metadata XML defined by the rule tree, typically to restore state. See [Custom behaviors and overrides](ref:custom-behaviors-and-overrides) for guidance on custom overrides. - [Get a custom override](https://techdocs.akamai.com/property-mgr/reference/get-custom-override.md): Get information for a single custom override. Use this operation if you want to examine the override's XML metadata. - [Bulk activate a set of properties](https://techdocs.akamai.com/property-mgr/reference/post-bulk-activations.md): Bulk activate a set of property versions. Alternately, perform a bulk [fallback](ref:property-activation-error-handling) to the previous activation within an hour of the previous bulk activation. Base the set of versions to activate on the results of a [bulk patch](ref:get-bulk-patch) operation, which you use in this operation's request. This operation launches an asynchronous process to update properties. To check its progress, run the [List bulk-activated properties](ref:get-bulk-activation) operation, whose link is available in the `Location` header or `bulkActivationLink` member of this operation's response. See [Bulk Search and Update](ref:bulk-search-and-update) for overall guidance on this feature. If your account is enabled for mandatory domain validation, you need to prove ownership of the domains you set up as property hostnames, before activating the property. You can either pre-validate your domains by [generating validation challenges](ref:post-domain-ownership-challenges) or use the challenges you get while [adding](ref:patch-property-version-hostnames), [listing](ref:get-property-version-hostnames), or [updating](ref:put-property-version-hostnames) your property version hostnames. [Learn more](https://techdocs.akamai.com/domain-validation/docs/welcome). - [List bulk-activated properties](https://techdocs.akamai.com/property-mgr/reference/get-bulk-activation.md): List all activations that result from a [bulk activation request](ref:post-bulk-activations). Once the overall `bulkActivationStatus` is `COMPLETE`, check each activation's `activationStatus` to confirm it's `ACTIVATED`. See [Bulk Search and Update](ref:bulk-search-and-update) for overall guidance on this feature. - [Bulk version a set of properties](https://techdocs.akamai.com/property-mgr/reference/post-bulk-version.md): Create new versions of a set of properties based on any previous version. This operation launches an asynchronous process to increment versions. To check its progress, run the [List bulk-versioned properties](ref:get-bulk-version) operation, whose link is available in the `Location` header or `bulkCreateVersionLink` member of this operation's response. Run this operation only after [bulk searching](ref:post-bulk-search) a set of properties you want to change, to prepare new versions to bulk patch. See [Bulk Search and Update](ref:bulk-search-and-update) for guidance on this feature. - [List bulk-versioned properties](https://techdocs.akamai.com/property-mgr/reference/get-bulk-version.md): List all new property versions that result from a [bulk versioning request](ref:post-bulk-version). This operation polls the asynchronous process's status. After the `bulkCreateVersionsStatus` is `COMPLETE`, use the new version numbers along with search paths from a [bulk search](ref:post-bulk-search) operation to [bulk patch](ref:post-bulk-patch) them. See [Bulk Search and Update](ref:bulk-search-and-update) for guidance. - [Bulk patch a set of properties](https://techdocs.akamai.com/property-mgr/reference/post-bulk-patch.md): Apply a series of JSON Patch operations to modify a set of property versions. Form this set of `patches` based on the [JSONPath](http://goessner.net/articles/JsonPath/) locations from a [bulk search](ref:post-bulk-search) response. Specify a set of new property versions based on the results of a [bulk versioning](ref:post-bulk-version) operation. The request is a bulk patch object. This operation launches an asynchronous process to update rule trees. To check its progress, run the [List bulk-updated properties](ref:get-bulk-patch) operation, whose link is available in the `Location` header or `bulkPatchLink` member of this operation's response. See [Bulk Search and Update](ref:bulk-search-and-update) for overall guidance on this feature. - [List bulk-patched properties](https://techdocs.akamai.com/property-mgr/reference/get-bulk-patch.md): List all modified property versions that result from a [bulk patch](ref:post-bulk-patch) request. This operation polls the asynchronous process's status. Once the overall `bulkPatchStatus` is `COMPLETE`, you can feed all successfully updated property versions whose `status` is `UPDATED` into a subsequent request to [bulk activate](ref:post-bulk-activations) them. See [Bulk Search and Update](ref:bulk-search-and-update) for overall guidance on this feature. - [Bulk search a set of properties or includes](https://techdocs.akamai.com/property-mgr/reference/post-bulk-search.md): POST a bulk search object to search across all active property or include versions. Specify a [JSONPath](http://goessner.net/articles/JsonPath/) expression to match their rule trees. This operation launches an asynchronous process to gather search results. To check its progress, run the [List bulk search results](ref:get-bulk-search) operation, whose link is available in the `Location` header or the `bulkSearchLink` member of this operation's response. After gathering completed results, you can create new property versions, bulk patch the rule trees, then activate them. See [Bulk Search and Update](ref:bulk-search-and-update) for guidance on this feature. Run [Synchronously bulk search a set of properties](ref:post-bulk-searchsynchronus) as an alternative to get completed search results directly. To perform simpler searches for an include's name or property's name or hostnames to which it applies, run the [Search properties and includes](ref:post-search-find-by-value) operation instead. - [Synchronously bulk search a set of properties or includes](https://techdocs.akamai.com/property-mgr/reference/post-bulk-search-synch.md): Provides an alternative to the asynchronous [Bulk search a set of properties or includes](ref:post-bulk-search) operation. It yields completed bulk search results directly, but with possibly high latency, making it more appropriate to target for small-batch searches. POST a bulk search object to search across all active property or include versions, specifying a [JSONPath](http://goessner.net/articles/JsonPath/) expression to match their rule trees. After gathering results, you can create new property versions, bulk patch the rule trees, then activate them. See [Bulk Search and Update](ref:bulk-search-and-update) for guidance on this feature. To perform simpler searches for an include's name or property's name or hostnames to which it applies, run the [Search properties and includes](ref:post-search-find-by-value) operation instead. - [List bulk search results](https://techdocs.akamai.com/property-mgr/reference/get-bulk-search.md): List all property or include versions that result from a [bulk search request](ref:post-bulk-search). Run this operation to poll the asynchronous process's status. Once the `searchTargetStatus` is `COMPLETE`, you can feed the `results` into a [bulk versioning](ref:post-bulk-version) operation. Also use the JSON path `matchLocations` to run a [bulk patch](ref:post-bulk-patch) operation over the rule trees. See [Bulk Search and Update](ref:bulk-search-and-update) for guidance. - [Search properties or includes](https://techdocs.akamai.com/property-mgr/reference/post-search-find-by-value.md): This operation searches includes by name, or properties either by name, hostname, or edge hostname for which they're currently active. Specify a search request object with a single query member. The response lists the matching set of currently active property or include versions, and also the latest version if inactive. Each of the response's versions features additional context for the property or include in which it appears, or the account, contract, or group under which it's deployed. Note that to perform more complex searches for content within a rule tree, run [Bulk search a set of properties or includes](ref:post-bulk-search) instead. - [Get build details](https://techdocs.akamai.com/property-mgr/reference/get-build.md): Gets information about the current API release. Note that available information about version numbers and build dates are unrelated to the overall API version or to various rule format versions. See [API versioning](ref:api-versioning) for details. - [Get client settings](https://techdocs.akamai.com/property-mgr/reference/get-client-settings.md): Get the current set of default values that apply to API clients keyed by the current authorization token. - [Update client settings](https://techdocs.akamai.com/property-mgr/reference/put-client-settings.md): Update the current set of default values that apply to API clients keyed by the current authorization token. - [List rule formats](https://techdocs.akamai.com/property-mgr/reference/get-rule-formats.md): Gets a list of available rule formats. Use these version strings available in the response's `ruleFormats.items` array to control the set of behaviors and criteria you invoke within an include's rules to apply to edge content. If you'd like to use the `latest` rule format and take advantage of the new or updated features Akamai releases routinely, see [Dynamic rule updates](ref:dynamic-rule-format-updates#upgrade-from-a-frozen-rule-format-to-latest) for more details. If you prefer to use a dated rule format version, see the instructions for [freezing](ref:rule-format-schemas#freeze-a-feature-set-for-a-rule-tree) a rule tree or [updating](ref:rule-format-schemas#update-rules-to-a-newer-set-of-features) to a new rule format. To validate a rule tree to the requirements of a specific rule format, see [Get a rule format's schema](ref:get-schemas-product-rule-format). - [Get a schema for a rule format](https://techdocs.akamai.com/property-mgr/reference/get-schemas-product-rule-format.md): Get the JSON schema for the given product and rule format, which you can use to validate a rule tree object. Note that your rule tree may still fail to activate if you specify features that are optional within the schema for a product but not currently supported on your contract. To validate the set of currently available features you want to activate, run [List available behaviors](ref:get-available-behaviors) and [List available criteria](ref:get-available-criteria). - [Get a schema for a request](https://techdocs.akamai.com/property-mgr/reference/get-schemas-request-filename.md): Fetch the JSON schema for a particular request. Error messages about schema mismatches typically link the schema filename. - [Generate challenges to verify domain ownership](https://techdocs.akamai.com/property-mgr/reference/post-domain-ownership-challenges.md): Confirm you own all the domains for property hostnames you configure. This keeps your domains safe and prevents other customers from using them to serve traffic over the Akamai edge network. You need to complete this validation before activating your property. ## Recipes - [Activate a property version](https://techdocs.akamai.com/property-mgr/recipes/activate-a-property-version.md) - [Activate an include](https://techdocs.akamai.com/property-mgr/recipes/activate-an-include.md) - [Add a hostname to an existing property](https://techdocs.akamai.com/property-mgr/recipes/add-a-hostname-to-an-existing-property.md) - [Add or remove hostnames for a property's hostname bucket](https://techdocs.akamai.com/property-mgr/recipes/add-or-remove-hostnames-for-a-propertys-hostname-bucket.md) - [Bulk search a set of properties](https://techdocs.akamai.com/property-mgr/recipes/bulk-search-a-set-of-properties.md) - [Cancel a pending include activation](https://techdocs.akamai.com/property-mgr/recipes/cancel-a-pending-include-activation.md) - [Cancel a pending property activation](https://techdocs.akamai.com/property-mgr/recipes/cancel-a-pending-property-activation.md) - [Cancel a pending property hostname activation](https://techdocs.akamai.com/property-mgr/recipes/cancel-a-pending-property-hostname-activation.md) - [Clone a property](https://techdocs.akamai.com/property-mgr/recipes/clone-a-property.md) - [Clone an include](https://techdocs.akamai.com/property-mgr/recipes/clone-an-include.md) - [Create a hostname bucket property](https://techdocs.akamai.com/property-mgr/recipes/create-a-hostname-bucket-property.md) - [Create a new CP code](https://techdocs.akamai.com/property-mgr/recipes/create-a-new-cp-code.md) - [Create a new include version](https://techdocs.akamai.com/property-mgr/recipes/create-a-new-include-version.md) - [Create a new property version](https://techdocs.akamai.com/property-mgr/recipes/create-a-new-property-version.md) - [Create a new property](https://techdocs.akamai.com/property-mgr/recipes/create-a-new-property.md) - [Create a Shared Certificate edge hostname](https://techdocs.akamai.com/property-mgr/recipes/create-a-shared-certificate-edge-hostname.md) - [Create a Standard TLS edge hostname](https://techdocs.akamai.com/property-mgr/recipes/create-a-standard-tls-edge-hostname.md) - [Create an Enhanced TLS edge hostname](https://techdocs.akamai.com/property-mgr/recipes/create-an-enhanced-tls-edge-hostname.md) - [Create an include](https://techdocs.akamai.com/property-mgr/recipes/create-an-include.md) - [Generate certificate domain validation challenges](https://techdocs.akamai.com/property-mgr/recipes/generate-certificate-domain-validation-challenges.md) - [Get a CP code](https://techdocs.akamai.com/property-mgr/recipes/get-a-cp-code.md) - [Get a property hostname activation](https://techdocs.akamai.com/property-mgr/recipes/get-a-property-hostname-activation.md) - [Get a property rule tree](https://techdocs.akamai.com/property-mgr/recipes/get-a-property-rule-tree.md) - [Get a property version](https://techdocs.akamai.com/property-mgr/recipes/get-a-property-version.md) - [Get a property](https://techdocs.akamai.com/property-mgr/recipes/get-a-property.md) - [Get an activation](https://techdocs.akamai.com/property-mgr/recipes/get-an-activation.md) - [Get an edge hostname](https://techdocs.akamai.com/property-mgr/recipes/get-an-edge-hostname.md) - [Get an include activation](https://techdocs.akamai.com/property-mgr/recipes/get-an-include-activation.md) - [Get an include version](https://techdocs.akamai.com/property-mgr/recipes/get-an-include-version.md) - [Get an include](https://techdocs.akamai.com/property-mgr/recipes/get-an-include.md) - [Get an include's rule tree](https://techdocs.akamai.com/property-mgr/recipes/get-an-includes-rule-tree.md) - [Get audit history for property hostnames](https://techdocs.akamai.com/property-mgr/recipes/get-audit-history-for-property-hostnames.md) - [Get property hostnames diff](https://techdocs.akamai.com/property-mgr/recipes/get-property-hostnames-diff.md) - [Get the latest include version](https://techdocs.akamai.com/property-mgr/recipes/get-the-latest-include-version.md) - [Get the latest property version](https://techdocs.akamai.com/property-mgr/recipes/get-the-latest-property-version.md) - [List activations](https://techdocs.akamai.com/property-mgr/recipes/list-activations.md) - [List available behaviors for a property](https://techdocs.akamai.com/property-mgr/recipes/list-available-behaviors-for-a-property.md) - [List available behaviors for an include](https://techdocs.akamai.com/property-mgr/recipes/list-available-behaviors-for-an-include.md) - [List available criteria for a property](https://techdocs.akamai.com/property-mgr/recipes/list-available-criteria-for-a-property.md) - [List available criteria for an include](https://techdocs.akamai.com/property-mgr/recipes/list-available-criteria-for-an-include.md) - [List bulk search results](https://techdocs.akamai.com/property-mgr/recipes/list-bulk-search-results.md) - [List contracts](https://techdocs.akamai.com/property-mgr/recipes/list-contracts.md) - [List CP codes](https://techdocs.akamai.com/property-mgr/recipes/list-cp-codes.md) - [List edge hostnames](https://techdocs.akamai.com/property-mgr/recipes/list-edge-hostnames.md) - [List groups](https://techdocs.akamai.com/property-mgr/recipes/list-groups-1.md) - [List hostname activations](https://techdocs.akamai.com/property-mgr/recipes/list-hostname-activations.md) - [List hostnames for a property (advanced domain validation)](https://techdocs.akamai.com/property-mgr/recipes/list-hostnames-for-a-property-advanced-domain-validation.md) - [List hostnames for a property version (advanced domain validation)](https://techdocs.akamai.com/property-mgr/recipes/list-hostnames-for-a-property-version-advanced-domain-validation.md) - [List hostnames for a property version](https://techdocs.akamai.com/property-mgr/recipes/list-hostnames-for-a-property-version.md) - [List hostnames for a property](https://techdocs.akamai.com/property-mgr/recipes/list-hostnames-for-a-property.md) - [List hostnames for an account](https://techdocs.akamai.com/property-mgr/recipes/list-hostnames-for-an-account.md) - [List include versions](https://techdocs.akamai.com/property-mgr/recipes/list-include-versions.md) - [List include's activations](https://techdocs.akamai.com/property-mgr/recipes/list-includes-activations.md) - [List includes](https://techdocs.akamai.com/property-mgr/recipes/list-includes.md) - [List parent properties](https://techdocs.akamai.com/property-mgr/recipes/list-parent-properties.md) - [List products](https://techdocs.akamai.com/property-mgr/recipes/list-products.md) - [List properties](https://techdocs.akamai.com/property-mgr/recipes/list-properties.md) - [List property versions](https://techdocs.akamai.com/property-mgr/recipes/list-property-versions.md) - [List use cases](https://techdocs.akamai.com/property-mgr/recipes/list-use-cases.md) - [Patch a rule tree](https://techdocs.akamai.com/property-mgr/recipes/patch-a-rule-tree.md) - [Patch an include's rule tree](https://techdocs.akamai.com/property-mgr/recipes/patch-an-includes-rule-tree.md) - [Remove a hostname from an existing property](https://techdocs.akamai.com/property-mgr/recipes/remove-a-hostname-from-an-existing-property.md) - [Remove a property](https://techdocs.akamai.com/property-mgr/recipes/remove-a-property.md) - [Remove an include](https://techdocs.akamai.com/property-mgr/recipes/remove-an-include.md) - [Resume domain validation](https://techdocs.akamai.com/property-mgr/recipes/resume-domain-validation.md) - [Search properties](https://techdocs.akamai.com/property-mgr/recipes/search-properties.md) - [Update a property with a CCM certificate hostname](https://techdocs.akamai.com/property-mgr/recipes/update-a-property-with-a-ccm-certificate-hostname.md) - [Update a property with a CPS-managed certificate hostname](https://techdocs.akamai.com/property-mgr/recipes/update-a-property-with-a-cps-managed-certificate-hostname.md) - [Update a property with a Default DV certificate hostname](https://techdocs.akamai.com/property-mgr/recipes/update-a-property-with-a-default-dv-certificate-hostname.md) - [Update a property with a shared certificate hostname](https://techdocs.akamai.com/property-mgr/recipes/update-a-property-with-a-shared-certificate-hostname.md) - [Update a property's rule tree](https://techdocs.akamai.com/property-mgr/recipes/update-a-propertys-rule-tree.md) - [Update an include's rule tree](https://techdocs.akamai.com/property-mgr/recipes/update-an-includes-rule-tree.md) ## Changelog - [Jun 22, 2026 - Support added for gRPC-Web to native translation](https://techdocs.akamai.com/property-mgr/changelog/jun-22-2026-support-added-for-grpc-web-to-native-translation.md) - [Jun 22, 2026 - New frozen rule format](https://techdocs.akamai.com/property-mgr/changelog/jun-22-2026-new-frozen-rule-format.md) - [Jun 9, 2026 - Catalog updates](https://techdocs.akamai.com/property-mgr/changelog/jun-9-2026-catalog-updates.md) - [May 20, 2026 - New frozen rule format](https://techdocs.akamai.com/property-mgr/changelog/may-18-2026-new-frozen-rule-format.md) - [May 7, 2026 - Catalog updates](https://techdocs.akamai.com/property-mgr/changelog/may-7-2026-catalog-updates.md) # Purge Cache Documentation > Akamai’s Purge Cache web interface on Control Center lets you refresh specific cached objects or remove all objects across Akamai’s edge network in just a few seconds. You can filter objects by URLs, Content Provider (CP) codes, or cache tags. Removing cached objects allows you to quickly correct mistakes in your published content. ## Guides - [Welcome to Purge Cache](https://techdocs.akamai.com/purge-cache/docs/welcome-purge.md) - [User permissions](https://techdocs.akamai.com/purge-cache/docs/purge-permissions.md) - [Purge mechanisms](https://techdocs.akamai.com/purge-cache/docs/purge-mechanisms.md) - [Invalidate and delete methods](https://techdocs.akamai.com/purge-cache/docs/purge-methods.md) - [Performance considerations](https://techdocs.akamai.com/purge-cache/docs/performance-considerations.md) - [Quick start](https://techdocs.akamai.com/purge-cache/docs/quick-start.md) - [Cache strategies](https://techdocs.akamai.com/purge-cache/docs/cache-strategies.md) - [Purge content by URL](https://techdocs.akamai.com/purge-cache/docs/purge-content-url.md) - [Purge content by ARL](https://techdocs.akamai.com/purge-cache/docs/purge-content-arl.md) - [Purge content by CP code](https://techdocs.akamai.com/purge-cache/docs/purge-content-cp-code.md) - [Purge content by cache tag](https://techdocs.akamai.com/purge-cache/docs/purge-content-cache-tag.md) - [Assign cache tags](https://techdocs.akamai.com/purge-cache/docs/assign-cache-tags.md) - [Cache tag use cases](https://techdocs.akamai.com/purge-cache/docs/cache-tag-use-cases.md) - [Purge content by directory and extensions](https://techdocs.akamai.com/purge-cache/docs/purge-content-dir-exts.md) - [View or resubmit previous ECCU requests](https://techdocs.akamai.com/purge-cache/docs/view-resubmit-previous-eccu-req.md) - [ECCU status messages](https://techdocs.akamai.com/purge-cache/docs/eccu-status-msg.md) - [Digital properties](https://techdocs.akamai.com/purge-cache/docs/digital-props.md) - [Create the ECCU request file](https://techdocs.akamai.com/purge-cache/docs/create-eccu-req-file.md) - [Revalidate tag](https://techdocs.akamai.com/purge-cache/docs/reval-tag.md) - [Path matches](https://techdocs.akamai.com/purge-cache/docs/path-matches.md) - [Request matches](https://techdocs.akamai.com/purge-cache/docs/req-matches.md) - [Response header match](https://techdocs.akamai.com/purge-cache/docs/response-header-match.md) - [Best practices for multiple requests](https://techdocs.akamai.com/purge-cache/docs/best-practices-multiple-req.md) - [ECCU request examples](https://techdocs.akamai.com/purge-cache/docs/eccu-req-x.md) - [ECCU performance considerations](https://techdocs.akamai.com/purge-cache/docs/eccu-performance.md) ## API Reference - [Fast Purge API v3](https://techdocs.akamai.com/purge-cache/reference/api.md) - [API summary](https://techdocs.akamai.com/purge-cache/reference/api-summary.md) - [Get started](https://techdocs.akamai.com/purge-cache/reference/api-get-started.md) - [Rate limiting](https://techdocs.akamai.com/purge-cache/reference/rate-limiting.md) - [Rate limit response examples](https://techdocs.akamai.com/purge-cache/reference/rate-limit-response-examples.md) - [Errors](https://techdocs.akamai.com/purge-cache/reference/api-errors.md) - [400](https://techdocs.akamai.com/purge-cache/reference/400.md) - [401](https://techdocs.akamai.com/purge-cache/reference/401.md) - [403](https://techdocs.akamai.com/purge-cache/reference/403.md) - [404](https://techdocs.akamai.com/purge-cache/reference/404.md) - [405](https://techdocs.akamai.com/purge-cache/reference/405.md) - [408](https://techdocs.akamai.com/purge-cache/reference/408.md) - [410](https://techdocs.akamai.com/purge-cache/reference/410.md) - [411](https://techdocs.akamai.com/purge-cache/reference/411.md) - [413](https://techdocs.akamai.com/purge-cache/reference/413.md) - [415](https://techdocs.akamai.com/purge-cache/reference/415.md) - [429](https://techdocs.akamai.com/purge-cache/reference/429.md) - [500](https://techdocs.akamai.com/purge-cache/reference/500.md) - [503](https://techdocs.akamai.com/purge-cache/reference/503.md) - [504](https://techdocs.akamai.com/purge-cache/reference/504.md) - [507](https://techdocs.akamai.com/purge-cache/reference/507.md) - [Invalidate by CP code](https://techdocs.akamai.com/purge-cache/reference/post-invalidate-cpcode.md): Invalidates content on the selected CP code for the selected `network`. You should consider invalidating content by default. This keeps each object in cache until the version on your origin server is newer. 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 is unreachable. - [Invalidate by cache tag](https://techdocs.akamai.com/purge-cache/reference/post-invalidate-tag.md): Invalidates content on the selected set of cache tags for the selected `network`. You should consider invalidating content by default. This keeps each object in cache until the version on your origin server is newer. 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 is unreachable. - [Invalidate by URL or ARL](https://techdocs.akamai.com/purge-cache/reference/post-invalidate-url.md): Invalidates content on the selected URL or ARL for the selected `network`. You should consider invalidating content by default. This keeps each object in cache until the version on your origin server is newer. 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 is unreachable. URLs and ARLs can be submitted in the same request. - [Delete by cache tag](https://techdocs.akamai.com/purge-cache/reference/post-delete-tag.md): Deletes content on the selected set of cache tags for the selected `network`. In most cases, you should [invalidate](ref:post-invalidate-tag) rather than delete content. Invalidation keeps each object in cache until the version on your origin server is newer. 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 is unreachable. - [Delete by URL or ARL](https://techdocs.akamai.com/purge-cache/reference/post-delete-url.md): Deletes content on the selected URL or ARL for the selected `network`. URLs and ARLs can be submitted in the same request. In most cases, you should [invalidate](ref:post-invalidate-url) rather than delete content. Invalidation keeps each object in cache until the version on your origin server is newer. 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 is unreachable. - [Delete by CP code](https://techdocs.akamai.com/purge-cache/reference/post-delete-cpcode.md): Deletes content on the selected CP code for the selected `network`. In most cases, you should [invalidate](ref:post-invalidate-cpcode) rather than delete content. Invalidation keeps each object in cache until the version on your origin server is newer. 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 is unreachable. - [Check rate and object limit statuses](https://techdocs.akamai.com/purge-cache/reference/post-rate-limit-status.md): The Fast Purge API uses a token bucket model for [rate limiting](ref: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](ref:429) error. ## Recipes - [Delete content by cache tag](https://techdocs.akamai.com/purge-cache/recipes/delete-content-by-cache-tag.md) - [Delete content by CP code](https://techdocs.akamai.com/purge-cache/recipes/delete-content-by-cp-code.md) - [Delete content by URL or ARL](https://techdocs.akamai.com/purge-cache/recipes/delete-content-by-url-or-arl.md) - [Invalidate content by cache tag](https://techdocs.akamai.com/purge-cache/recipes/invalidate-content-by-cache-tag.md) - [Invalidate content by CP code](https://techdocs.akamai.com/purge-cache/recipes/invalidate-content-by-cp-code.md) - [Invalidate content by URL or ARL](https://techdocs.akamai.com/purge-cache/recipes/invalidate-content-by-url-or-arl.md) ## Changelog - [Jan 2, 2023 — Postman collection available](https://techdocs.akamai.com/purge-cache/changelog/jan-2-2023-postman-collection-available.md) - [Aug 31, 2021 — New Purge Cache documentation experience](https://techdocs.akamai.com/purge-cache/changelog/aug-27-2021-new-purge-cache-documentation-experience.md) - [Jan 30, 2019 — New Enhanced Content Control Utility User Interface](https://techdocs.akamai.com/purge-cache/changelog/new-eccu-ui.md) - [Aug 1, 2017 — Purge by Content Provider (CP) code Limited Availability release](https://techdocs.akamai.com/purge-cache/changelog/purge-by-cp-code-la.md) - [Jul 1, 2017 — Purge by Cache Tag available in Beta](https://techdocs.akamai.com/purge-cache/changelog/purge-by-cache-tag-beta.md) # Release Notes Documentation > Documentation for Release Notes ## Guides - [Documentation](https://techdocs.akamai.com/release-notes/docs.md): Release Notes documentation # Reporting Documentation > If you’re using Akamai’s Intelligent Platform to deliver your content, you want to see how it’s performing. Reporting lets you create a wide range of reports, with new kinds added periodically. It lets you retrieve data in intervals from minutes to months. ## Guides - [Welcome to Reporting](https://techdocs.akamai.com/reporting/docs/welcome-rpt.md) - [Reporting overview](https://techdocs.akamai.com/reporting/docs/rpts-overview.md) - [Use predefined reports](https://techdocs.akamai.com/reporting/docs/how-use-rpts.md) - [Date ranges](https://techdocs.akamai.com/reporting/docs/date-ranges.md) - [Filters](https://techdocs.akamai.com/reporting/docs/filters.md) - [Data presentation](https://techdocs.akamai.com/reporting/docs/data-presentation.md) - [Scheduled reports](https://techdocs.akamai.com/reporting/docs/scheduled-rpts.md) - [Use custom reports](https://techdocs.akamai.com/reporting/docs/use-custom-rpts.md) - [Access saved reports](https://techdocs.akamai.com/reporting/docs/access-saved-rpts.md) - [Work with a custom report](https://techdocs.akamai.com/reporting/docs/work-with-custom-rpt.md) - [Traffic reports](https://techdocs.akamai.com/reporting/docs/traffic-rpts.md) - [Edge DNS reports](https://techdocs.akamai.com/reporting/docs/edge-dns-rpts.md) - [Infrastructure Security Analytics reports](https://techdocs.akamai.com/reporting/docs/infrasec-analytics-rpts.md) - [Network Observability Analytics (NOA) reports](https://techdocs.akamai.com/reporting/docs/network-observability-analytics-noa-reports.md) - [Liveness Checks](https://techdocs.akamai.com/reporting/docs/liveness-checks.md) - [Top Talkers](https://techdocs.akamai.com/reporting/docs/top-talkers.md) - [Prolexic reports](https://techdocs.akamai.com/reporting/docs/prolexic-rpts.md) - [GTM reports](https://techdocs.akamai.com/reporting/docs/gtm-rpts.md) - [Web and mobile optimization](https://techdocs.akamai.com/reporting/docs/web-mobile-optimization.md) - [Data Products reports](https://techdocs.akamai.com/reporting/docs/data-products-rpts.md) - [Software as a Service (SaaS)](https://techdocs.akamai.com/reporting/docs/software-service-saas.md) - [API Gateway reports](https://techdocs.akamai.com/reporting/docs/api-gateway-rpts.md) - [Cloud Wrapper reports](https://techdocs.akamai.com/reporting/docs/cloud-wrapper-rpts.md) - [NetStorage reports](https://techdocs.akamai.com/reporting/docs/netstorage-rpts.md) - [Media Services Live reports](https://techdocs.akamai.com/reporting/docs/media-services-live-rpts.md) ## API Reference - [Reporting API v2](https://techdocs.akamai.com/reporting/reference/api.md) - [API summary](https://techdocs.akamai.com/reporting/reference/api-summary.md) - [Get started](https://techdocs.akamai.com/reporting/reference/get-started.md) - [API workflow](https://techdocs.akamai.com/reporting/reference/api-workflow.md) - [Use filters](https://techdocs.akamai.com/reporting/reference/use-filters.md) - [Retrieve data asynchronously](https://techdocs.akamai.com/reporting/reference/retrieve-data-asynchronously.md) - [Available reports](https://techdocs.akamai.com/reporting/reference/available-reports.md) - [delivery/ivm/image-urls](https://techdocs.akamai.com/reporting/reference/delivery-ivm-image-urls.md) - [delivery/ivm/image-traffic](https://techdocs.akamai.com/reporting/reference/delivery-ivm-image-traffic.md) - [delivery/ivm/video-policy-stats](https://techdocs.akamai.com/reporting/reference/delivery-ivm-video-policy-stats.md) - [delivery/ivm/image-policy-stats](https://techdocs.akamai.com/reporting/reference/delivery-ivm-image-policy-stats.md) - [delivery/ivm/video-urls](https://techdocs.akamai.com/reporting/reference/delivery-ivm-video-urls.md) - [delivery/traffic/current](https://techdocs.akamai.com/reporting/reference/delivery-traffic-current.md) - [delivery/traffic/emissions](https://techdocs.akamai.com/reporting/reference/delivery-traffic-emissions.md) - [delivery/purge/usage](https://techdocs.akamai.com/reporting/reference/delivery-purge-usage.md) - [delivery/purge/audit-objects-details](https://techdocs.akamai.com/reporting/reference/delivery-purge-audit-objects-details.md) - [delivery/purge/audit-requests-details](https://techdocs.akamai.com/reporting/reference/delivery-purge-audit-requests-details.md) - [common/apis/usage](https://techdocs.akamai.com/reporting/reference/common-apis-usage.md) - [common/apis/usage-details](https://techdocs.akamai.com/reporting/reference/common-apis-usage-details.md) - [Rate limiting](https://techdocs.akamai.com/reporting/reference/rate-limiting.md) - [Errors](https://techdocs.akamai.com/reporting/reference/errors.md) - [400](https://techdocs.akamai.com/reporting/reference/400.md) - [401](https://techdocs.akamai.com/reporting/reference/401.md) - [403](https://techdocs.akamai.com/reporting/reference/403.md) - [404](https://techdocs.akamai.com/reporting/reference/404.md) - [422](https://techdocs.akamai.com/reporting/reference/422.md) - [429](https://techdocs.akamai.com/reporting/reference/429.md) - [500](https://techdocs.akamai.com/reporting/reference/500.md) - [List reports](https://techdocs.akamai.com/reporting/reference/get-reports.md): Returns all available reports. - [List reports per product family](https://techdocs.akamai.com/reporting/reference/get-reports-per-product-family.md): Returns all available reports for a product family. - [List reports per reporting area](https://techdocs.akamai.com/reporting/reference/get-reports-per-reporting-area.md): Returns all available reports for a product family and reporting area. - [Get report options](https://techdocs.akamai.com/reporting/reference/get-report-options.md): Returns available options to generate the report. - [Generate a report](https://techdocs.akamai.com/reporting/reference/post-report-data.md): Produces a report in either JSON or CSV format. - [Get asynchronous report results](https://techdocs.akamai.com/reporting/reference/get-report-data-async.md): Produces a report for an asynchronous request in either JSON or CSV format. ## Recipes - [Generate a report](https://techdocs.akamai.com/reporting/recipes/generate-a-report.md) - [Get asynchronous report results](https://techdocs.akamai.com/reporting/recipes/get-asynchronous-report-results.md) - [Get report options](https://techdocs.akamai.com/reporting/recipes/get-report-options.md) - [List reports per product family](https://techdocs.akamai.com/reporting/recipes/list-reports-per-product-family.md) - [List reports per reporting area](https://techdocs.akamai.com/reporting/recipes/list-reports-per-reporting-area.md) - [List reports](https://techdocs.akamai.com/reporting/recipes/list-reports.md) ## Changelog - [Apr 1, 2026 - Custom reports available in Control Center](https://techdocs.akamai.com/reporting/changelog/apr-1-2026-custom-reports-available-in-control-center.md) - [Jan 30, 2026 - Traffic and Today's Traffic reports API sunset](https://techdocs.akamai.com/reporting/changelog/traffic-and-todays-traffic-reports-api-sunset.md) - [Oct 13, 2025 — Routed Trends reports update](https://techdocs.akamai.com/reporting/changelog/oct-13-2025-routed-trends-reports-update.md) - [Aug 11, 2025 — Updates to Routed Trends reports](https://techdocs.akamai.com/reporting/changelog/updates-routed-trends-rpts.md) - [Jun 30, 2025 - Exclude GET/HEAD requests filter in the Traffic by Hostname report](https://techdocs.akamai.com/reporting/changelog/jun-30-2025-exclude-gethead-requests-filter-in-traffic-by-hostname.md) # Script Management Documentation > Akamai's Script Management is a suite of tools to help you minimize performance impacts from JavaScripts. ## Guides - [Welcome to Script Management](https://techdocs.akamai.com/script-management/docs/welcome-script-management.md) - [Review script usage](https://techdocs.akamai.com/script-management/docs/review-script-usage.md) - [Create a policy](https://techdocs.akamai.com/script-management/docs/create-a-policy.md) - [Optional policy features](https://techdocs.akamai.com/script-management/docs/optional-policy-features.md) - [Troubleshoot policies](https://techdocs.akamai.com/script-management/docs/troubleshooting.md) - [Dashboard metrics reference](https://techdocs.akamai.com/script-management/docs/modes-and-the-service-worker.md) - [Additional testing tools](https://techdocs.akamai.com/script-management/docs/script-management-policy-teste.md) - [Additional Service Worker tools](https://techdocs.akamai.com/script-management/docs/service-worker-tools.md) ## API Reference - [Script Management API](https://techdocs.akamai.com/script-management/reference/api.md) - [API summary](https://techdocs.akamai.com/script-management/reference/api-summary.md) - [Get started](https://techdocs.akamai.com/script-management/reference/get-started.md) - [Script Management concepts](https://techdocs.akamai.com/script-management/reference/script-mgmt-concepts.md) - [Rate limiting](https://techdocs.akamai.com/script-management/reference/rate-limiting.md) - [Errors](https://techdocs.akamai.com/script-management/reference/errors.md) - [400](https://techdocs.akamai.com/script-management/reference/400.md) - [401](https://techdocs.akamai.com/script-management/reference/401.md) - [403](https://techdocs.akamai.com/script-management/reference/403.md) - [404](https://techdocs.akamai.com/script-management/reference/404.md) - [409](https://techdocs.akamai.com/script-management/reference/409.md) - [500](https://techdocs.akamai.com/script-management/reference/500.md) - [Get insights](https://techdocs.akamai.com/script-management/reference/get-property-hostname-network-insights.md): Returns script performance information for the specified `propertyId`, `hostname`, and `network`. - [Get a policy](https://techdocs.akamai.com/script-management/reference/get-property-hostname-network-policies.md): Returns information about the latest version of a policy for the specified `property`, `hostname`, and `network`. - [Create a policy](https://techdocs.akamai.com/script-management/reference/post-property-hostname-network-policy.md): Creates a new policy for the specified `propertyId`, `hostname`, and `network`. The policy request needs to include the `spofConfig` object or `scriptConfig` array item, but it can contain both. Only one policy can exist per `hostname`. A change to the `spofConfig` or `scriptConfig` overwrites the existing policy. If a policy already exists with the same `spofConfig` and `scriptConfig`, the API responds with a 409 error and displays the existing policy. ## Recipes - [Create a policy for testing](https://techdocs.akamai.com/script-management/recipes/create-a-policy-for-testing.md) - [Get a policy](https://techdocs.akamai.com/script-management/recipes/get-a-policy.md) - [Get insights](https://techdocs.akamai.com/script-management/recipes/get-insights.md) - [Go live with a policy](https://techdocs.akamai.com/script-management/recipes/go-live-with-a-policy.md) ## Changelog - [Feb 1, 2022— New Script Management documentation experience](https://techdocs.akamai.com/script-management/changelog/feb-1-2022-new-script-management-documentation-experience.md) - [Apr 26, 2021 — Defer and block scripts using an Override List](https://techdocs.akamai.com/script-management/changelog/apr-26-202-defer-and-block-scripts-using-an-override-list.md) - [Mar 8, 2021 — Script Management available from the Services menu in Akamai Control Center](https://techdocs.akamai.com/script-management/changelog/march-8-2021-script-management-available-from-the-services-menu-in-akamai-control-center.md) - [Feb 23, 2021 — Access groups from the Script Management dashboard](https://techdocs.akamai.com/script-management/changelog/feb-23-2021-access-groups-from-the-script-management-dashboard.md) - [Oct 22, 2020 — Notification when SPOF activity exceeds 10%](https://techdocs.akamai.com/script-management/changelog/oct-22-2020-notification-when-spof-activity-exceeds-10-per-cent.md) # Security Center Documentation > Akamai’s security products defend against many different types of attacks. For each attack, you generally want to know who is attacking and which site is being targeted. Different attacks, however, may require the use of different features of Akamai’s security product line. Sorting this out requires presenting specific information related to the situation—which is where Akamai Security Center comes in. It gives you the information you need in a clear and quickly scannable way. Security Center’s dashboard displays high-level information on security events, traffic, and attack activity, all separated into four categories: DoS attack, application layer attack, bot activity, and custom rule activity. ## Guides - [Welcome to Security Center](https://techdocs.akamai.com/security-ctr/docs/security-center-ov.md) - [Access Security Center](https://techdocs.akamai.com/security-ctr/docs/access-security-center.md) - [Navigate Security Center](https://techdocs.akamai.com/security-ctr/docs/navigate-security-center.md) - [Welcome to Security Hub ](https://techdocs.akamai.com/security-ctr/docs/welcome-to-security-hub.md) - [Understand your security posture](https://techdocs.akamai.com/security-ctr/docs/understand-your-security-posture.md) - [Improve your posture score](https://techdocs.akamai.com/security-ctr/docs/improve-your-posture-score.md) - [View attack traffic trends and details](https://techdocs.akamai.com/security-ctr/docs/view-attack-traffic-trends-and-details.md) - [View web security dashboard](https://techdocs.akamai.com/security-ctr/docs/view-web-security-dashboard.md) - [View DoS trends](https://techdocs.akamai.com/security-ctr/docs/view-dos-trends.md) - [View WAF Rate Control trends](https://techdocs.akamai.com/security-ctr/docs/view-waf-rate-control-trends.md) - [View WAF trends](https://techdocs.akamai.com/security-ctr/docs/view-waf-trends.md) - [View Web Security Events](https://techdocs.akamai.com/security-ctr/docs/view-web-security-events.md) - [Routed reports](https://techdocs.akamai.com/security-ctr/docs/routed-reports.md) - [Client-Side Protection & Compliance reports](https://techdocs.akamai.com/security-ctr/docs/client-side-protect-compliance-reports.md) - [Bot reports](https://techdocs.akamai.com/security-ctr/docs/bot-reports.md) - [Client Reputation reports](https://techdocs.akamai.com/security-ctr/docs/client-reputation-reports.md) - [Schedule reports](https://techdocs.akamai.com/security-ctr/docs/schedule-reports.md) - [Sampled reporting results](https://techdocs.akamai.com/security-ctr/docs/sampling.md) - [Web Security Analytics overview](https://techdocs.akamai.com/security-ctr/docs/web-security-analytics-ov-new.md) - [Navigate Web Security Analytics](https://techdocs.akamai.com/security-ctr/docs/navigate-l-web-security-analytics.md) - [Build your dashboard](https://techdocs.akamai.com/security-ctr/docs/build-dashboard.md) - [Dimensions](https://techdocs.akamai.com/security-ctr/docs/dimensions-new.md) - [Save views](https://techdocs.akamai.com/security-ctr/docs/save-views.md) - [Manage views](https://techdocs.akamai.com/security-ctr/docs/manage-views.md) - [Samples view](https://techdocs.akamai.com/security-ctr/docs/samples-view-new.md) - [View requests](https://techdocs.akamai.com/security-ctr/docs/view-requests-new.md) - [View headers](https://techdocs.akamai.com/security-ctr/docs/view-headers-new.md) - [View client information](https://techdocs.akamai.com/security-ctr/docs/view-client-information-new.md) - [View rules](https://techdocs.akamai.com/security-ctr/docs/view-rules-new.md) - [Export samples](https://techdocs.akamai.com/security-ctr/docs/export-samples-new.md) - [Filters](https://techdocs.akamai.com/security-ctr/docs/filters.md) - [Add a filter](https://techdocs.akamai.com/security-ctr/docs/add-filter.md) - [Remove a filter](https://techdocs.akamai.com/security-ctr/docs/rm-filter.md) - [Alerts](https://techdocs.akamai.com/security-ctr/docs/alerts-new.md) - [Create an alert](https://techdocs.akamai.com/security-ctr/docs/create-alert.md) - [Enable or disable an alert](https://techdocs.akamai.com/security-ctr/docs/enable-disable-alert-new.md) - [Managing alerts](https://techdocs.akamai.com/security-ctr/docs/managing-alerts-new.md) - [Webhook notifications](https://techdocs.akamai.com/security-ctr/docs/webhook-notifications.md) - [Live mode](https://techdocs.akamai.com/security-ctr/docs/live-mode.md) - [Get help and advanced insights with AI Assistant](https://techdocs.akamai.com/security-ctr/docs/ai-assistant.md) - [Create custom rules with AI Assistant](https://techdocs.akamai.com/security-ctr/docs/create-custom-rules-with-ai-assistant.md) - [Improve bot and abuse detection accuracy](https://techdocs.akamai.com/security-ctr/docs/improve-detection-accuracy.md) - [System change indication (Beta)](https://techdocs.akamai.com/security-ctr/docs/system-change-indication.md) - [Dynamic throttling](https://techdocs.akamai.com/security-ctr/docs/throttling.md) - [Add identifiers to a client list](https://techdocs.akamai.com/security-ctr/docs/add-identifiers-to-a-client-list.md) ## Changelog - [Jul 14, 2026- Improvements to Web Security Analytics](https://techdocs.akamai.com/security-ctr/changelog/jul-14-2026-improvements-to-web-security-analytics.md) - [Jun 10, 2026 — The new standard for User Risk Levels](https://techdocs.akamai.com/security-ctr/changelog/jun-10-2026-the-new-standard-for-user-risk-levels.md) - [Jun 8, 2026- Improvements to Web Security Analytics](https://techdocs.akamai.com/security-ctr/changelog/jun-8-2026-improvements-to-web-security-analytics.md) - [Jun 8, 2026 — System Change Indications on WSA Beta](https://techdocs.akamai.com/security-ctr/changelog/jun-8-2026-system-change-indications-on-wsa-beta.md) - [Jun 2, 2026 — The new standard for User Risk Levels](https://techdocs.akamai.com/security-ctr/changelog/jun-2-2026-the-new-standard-for-user-risk-levels.md) # Secure Internet Access Enterprise Documentation > Secure Internet Access Enterprise (SIA) leverages real-time Akamai Cloud Security Intelligence and Akamai’s proven, globally distributed, recursive DNS platform to identify and block targeted threats such as malware, ransomware, DNS data exfiltration, and phishing. Akamai’s cloud portal lets security teams centrally manage and enforce unified security and acceptable use policies for all employees in minutes. ## Guides - [Welcome to SIA](https://techdocs.akamai.com/etp/docs/welcome-etp.md) - [Learn about SIA](https://techdocs.akamai.com/etp/docs/learn-about-etp.md) - [Set up SIA](https://techdocs.akamai.com/etp/docs/set-up-etp.md) - [Set up other SIA components](https://techdocs.akamai.com/etp/docs/setup-other-components.md) - [Configure DNS forwarding](https://techdocs.akamai.com/etp/docs/dns-forwarding.md) - [Configure your firewall](https://techdocs.akamai.com/etp/docs/configure-your-firewall.md) - [Set up a dashboard](https://techdocs.akamai.com/etp/docs/setup-dashboard.md) - [Set a default contract](https://techdocs.akamai.com/etp/docs/set-default-contract.md) - [Features in technical preview, beta, or limited availability](https://techdocs.akamai.com/etp/docs/features-not-released.md) - [SIA status page](https://techdocs.akamai.com/etp/docs/etp-status-page.md) - [Create a location](https://techdocs.akamai.com/etp/docs/create-location.md) - [About locations](https://techdocs.akamai.com/etp/docs/about-locations.md) - [Manage a location](https://techdocs.akamai.com/etp/docs/manage-location.md) - [Create a policy](https://techdocs.akamai.com/etp/docs/create-policy.md) - [About policies](https://techdocs.akamai.com/etp/docs/about-policies.md) - [Assign SIA policy](https://techdocs.akamai.com/etp/docs/assign-policy.md) - [Priority of SIA policies](https://techdocs.akamai.com/etp/docs/priority-policies.md) - [Manage a policy](https://techdocs.akamai.com/etp/docs/manage-policy.md) - [Acceptable use policy](https://techdocs.akamai.com/etp/docs/acceptable-use-policy.md) - [User authentication and group policies](https://techdocs.akamai.com/etp/docs/authentication-group-policies.md) - [Set up a custom header](https://techdocs.akamai.com/etp/docs/custom-headers.md) - [Create a list](https://techdocs.akamai.com/etp/docs/create-list.md) - [About lists](https://techdocs.akamai.com/etp/docs/about-lists.md) - [Manage a list](https://techdocs.akamai.com/etp/docs/manage-lists.md) - [Manage an identity provider](https://techdocs.akamai.com/etp/docs/set-up-idp.md) - [About identity providers](https://techdocs.akamai.com/etp/docs/about-identity-providers.md) - [Set up Okta as an identity provider](https://techdocs.akamai.com/etp/docs/setup-okta-idp.md) - [Set up Active Directory Federation Services (AD FS) as a third-party SAML identity provider](https://techdocs.akamai.com/etp/docs/setup-adfs-idp.md) - [Set up Microsoft Azure as a third-party SAML identity provider](https://techdocs.akamai.com/etp/docs/setup-azure-idp.md) - [Set up PingOne as an identity provider](https://techdocs.akamai.com/etp/docs/setup-pingone-idp.md) - [Enable multi-factor authentication](https://techdocs.akamai.com/etp/docs/enable-mfa.md) - [Set up directories and identity connectors](https://techdocs.akamai.com/etp/docs/setup-directories-identityconnectors.md) - [About directories](https://techdocs.akamai.com/etp/docs/directories.md) - [Manage a directory](https://techdocs.akamai.com/etp/docs/manage-directory.md) - [Provision users with SCIM](https://techdocs.akamai.com/etp/docs/scim.md) - [About identity connectors](https://techdocs.akamai.com/etp/docs/identity-connectors.md) - [Set up an identity connector](https://techdocs.akamai.com/etp/docs/setup-identity-connector.md) - [Connector-to-VM and cloud platform compatibility](https://techdocs.akamai.com/etp/docs/connector-vm-compatibility.md) - [Create and download an identity connector](https://techdocs.akamai.com/etp/docs/create-download-idconnector.md) - [Manage an identity connector](https://techdocs.akamai.com/etp/docs/manage-identity-connector.md) - [Configure access control](https://techdocs.akamai.com/etp/docs/configure-access-control.md) - [Application visibility and control](https://techdocs.akamai.com/etp/docs/application-visibility-control.md) - [Data loss prevention](https://techdocs.akamai.com/etp/docs/data-loss-prevention.md) - [Access by file type](https://techdocs.akamai.com/etp/docs/access-file-type.md) - [Use device posture for application access](https://techdocs.akamai.com/etp/docs/device-posture.md) - [Configure firewall rules](https://techdocs.akamai.com/etp/docs/configure-firewall-rules.md) - [Encrypt DNS queries and validate DNS responses with DNSSEC](https://techdocs.akamai.com/etp/docs/configure-dot-doh.md) - [Deploy configuration changes](https://techdocs.akamai.com/etp/docs/deploy-configuration-changes.md) - [Grant delegated or tenant access](https://techdocs.akamai.com/etp/docs/delegated-tenant-access.md) - [View connection information](https://techdocs.akamai.com/etp/docs/view-connection-information.md) - [Enable DNS Protection in China](https://techdocs.akamai.com/etp/docs/dns-protection-china.md) - [Configure general settings](https://techdocs.akamai.com/etp/docs/configure-general-settings.md) - [Customize error pages](https://techdocs.akamai.com/etp/docs/customize-error-pages.md) - [Configure a custom response](https://techdocs.akamai.com/etp/docs/configure-custom-response.md) - [Customize the Login Portal](https://techdocs.akamai.com/etp/docs/customize-login-portal.md) - [Clear DNS cache](https://techdocs.akamai.com/etp/docs/clear-dns-cache.md) - [Export SIA logs](https://techdocs.akamai.com/etp/docs/export-logs.md) - [About SIA Proxy](https://techdocs.akamai.com/etp/docs/about-etp-proxy.md) - [Selective proxy](https://techdocs.akamai.com/etp/docs/selective-proxy.md) - [Full web proxy](https://techdocs.akamai.com/etp/docs/full-web-proxy.md) - [Benefits of SIA Proxy](https://techdocs.akamai.com/etp/docs/benefits-etp-proxy.md) - [Limitations of SIA Proxy](https://techdocs.akamai.com/etp/docs/limitations-etp-proxy.md) - [SIA Proxy MITM certificate](https://techdocs.akamai.com/etp/docs/proxy-mitm-certificate.md) - [Payload analysis](https://techdocs.akamai.com/etp/docs/payload-analysis.md) - [Bypass list](https://techdocs.akamai.com/etp/docs/bypass-list.md) - [Support of an on-premises HTTP forward proxy](https://techdocs.akamai.com/etp/docs/support-onprem-proxy.md) - [Set up on-premises proxy for the full web proxy](https://techdocs.akamai.com/etp/docs/onpremises-proxy-setup.md) - [PAC file configuration](https://techdocs.akamai.com/etp/docs/pac-file-configuration.md) - [Unverifiable origin certificates](https://techdocs.akamai.com/etp/docs/unverifiable-origin-certificates.md) - [Supported cipher suites](https://techdocs.akamai.com/etp/docs/supported-cipher-suites.md) - [Zero-day phishing detection](https://techdocs.akamai.com/etp/docs/zero-day-phishing.md) - [Scan file sharing downloads for malware](https://techdocs.akamai.com/etp/docs/scan-filesharing-downloads.md) - [Set up SIA Proxy](https://techdocs.akamai.com/etp/docs/set-up-proxy.md) - [Create a SIA Proxy MITM certificate](https://techdocs.akamai.com/etp/docs/create-mitm-certificate.md) - [Distribute the SIA Proxy certificate](https://techdocs.akamai.com/etp/docs/distribute-proxy-certificate.md) - [Manage a certificate](https://techdocs.akamai.com/etp/docs/manage-certificate.md) - [Enable full web proxy](https://techdocs.akamai.com/etp/docs/enable-full-proxy.md) - [Enable selective proxy](https://techdocs.akamai.com/etp/docs/enable-selective-proxy.md) - [Set up proxy chaining](https://techdocs.akamai.com/etp/docs/proxy-chaining.md) - [Configure proxy authorization](https://techdocs.akamai.com/etp/docs/proxy-authorization.md) - [Configure Squid to forward traffic to SIA Proxy](https://techdocs.akamai.com/etp/docs/configure-squid.md) - [Set up IPsec tunnels](https://techdocs.akamai.com/etp/docs/set-up-ipsec.md) - [Prepare for SD-WAN setup](https://techdocs.akamai.com/etp/docs/prepare-sdwan-setup.md) - [Set up IPsec tunnels between your SD-WAN solution and SIA](https://techdocs.akamai.com/etp/docs/set-tunnels.md) - [Create IPsec tunnels in Aruba EdgeConnect SD-WAN](https://techdocs.akamai.com/etp/docs/ipsec-aruba.md) - [Create IPsec tunnels in VMware SD-WAN](https://techdocs.akamai.com/etp/docs/ipsec-vmware.md) - [Create IPsec tunnels in Cisco SD-WAN](https://techdocs.akamai.com/etp/docs/ipsec-cisco.md) - [Create IPsec tunnels in Sophos Firewall](https://techdocs.akamai.com/etp/docs/ipsec-sophos-firewall.md) - [Create IPsec tunnels on a Cradlepoint Router](https://techdocs.akamai.com/etp/docs/ipsec-cradlepoint.md) - [Supported cipher suites for IPsec](https://techdocs.akamai.com/etp/docs/ipsec-cipher-suites.md) - [Configure the proxy in browsers](https://techdocs.akamai.com/etp/docs/configure-proxy-browsers.md) - [Configure payload analysis](https://techdocs.akamai.com/etp/docs/configure-payload-analysis.md) - [Enable source IP address binding](https://techdocs.akamai.com/etp/docs/source-ip-binding.md) - [Configure other SIA Proxy settings](https://techdocs.akamai.com/etp/docs/configure-proxy-settings.md) - [About ETP Client](https://techdocs.akamai.com/etp/docs/about-etp-client.md) - [ETP Client for DNS only](https://techdocs.akamai.com/etp/docs/etpclient-dns-only.md) - [ETP Client for web traffic](https://techdocs.akamai.com/etp/docs/etpclient-web-traffic.md) - [DNS over TLS](https://techdocs.akamai.com/etp/docs/dns-over-tls.md) - [ETP Client configuration settings](https://techdocs.akamai.com/etp/docs/etpclient-config-settings.md) - [ETP Client version number convention](https://techdocs.akamai.com/etp/docs/etpclient-versions.md) - [ETP Client version support](https://techdocs.akamai.com/etp/docs/etpclient-version-support.md) - [Prepare for ETP Client setup](https://techdocs.akamai.com/etp/docs/prepare-etpclient-setup.md) - [Desktop client](https://techdocs.akamai.com/etp/docs/desktop-client.md) - [Set up ETP desktop client](https://techdocs.akamai.com/etp/docs/setup-desktop-client.md) - [Supported desktop operating systems](https://techdocs.akamai.com/etp/docs/supported-desktop-os.md) - [Download and approval statuses](https://techdocs.akamai.com/etp/docs/client-download-statuses.md) - [ETP Client statuses on desktop computers and machines](https://techdocs.akamai.com/etp/docs/etpclient-on-desktop.md) - [Automatic software upgrades and security patches](https://techdocs.akamai.com/etp/docs/upgrades-patches.md) - [Enable transparent traffic interception](https://techdocs.akamai.com/etp/docs/transparent-traffic-interception.md) - [Configure Mozilla Firefox to use system proxy settings](https://techdocs.akamai.com/etp/docs/configure-firefox-proxy.md) - [Allow ETP Client connections on Microsoft Edge](https://techdocs.akamai.com/etp/docs/client-connections-edge.md) - [Disable DNS over HTTPS on enterprise browsers](https://techdocs.akamai.com/etp/docs/disable-doh-browsers.md) - [Enable walled garden](https://techdocs.akamai.com/etp/docs/enable-walled-garden.md) - [Undo ETP Client approval](https://techdocs.akamai.com/etp/docs/undo-client-approval.md) - [Uninstall ETP Client](https://techdocs.akamai.com/etp/docs/uninstall-etp-client.md) - [Software rollback](https://techdocs.akamai.com/etp/docs/etpclient-software-rollback.md) - [Enable or disable ETP Client](https://techdocs.akamai.com/etp/docs/enable-disable-client.md) - [Web Proxy Auto-Discovery (WPAD) on Windows](https://techdocs.akamai.com/etp/docs/wpad-windows.md) - [Mobile client](https://techdocs.akamai.com/etp/docs/etp-mobile-client.md) - [Distribute the mobile client with Google Workspace Endpoint Management](https://techdocs.akamai.com/etp/docs/google-endpoint-mgmt.md) - [Distribute the mobile client with Microsoft Intune](https://techdocs.akamai.com/etp/docs/distribute-microsoft-intune.md) - [Distribute the mobile client with Workspace ONE UEM](https://techdocs.akamai.com/etp/docs/distribute-workspace-one.md) - [Distribute the mobile client with MobileIron](https://techdocs.akamai.com/etp/docs/distribute-mobileiron.md) - [Bring your own device (BYOD) support](https://techdocs.akamai.com/etp/docs/byod-support.md) - [Set up Bring Your Own Device (BYOD)](https://techdocs.akamai.com/etp/docs/set-up-byod.md) - [ETP Client activation](https://techdocs.akamai.com/etp/docs/client-activation.md) - [ETP Client reports](https://techdocs.akamai.com/etp/docs/etpclient-reports.md) - [Disable ETP Client](https://techdocs.akamai.com/etp/docs/disable-etp-client.md) - [Handle lost devices](https://techdocs.akamai.com/etp/docs/lost-devices.md) - [View the entitlement code](https://techdocs.akamai.com/etp/docs/view-entitlement-code.md) - [About Security Connector](https://techdocs.akamai.com/etp/docs/about-security-connector.md) - [Security Connector as a DNS forwarder](https://techdocs.akamai.com/etp/docs/about-dns-forwarder.md) - [Security Connector as an HTTP Forwarder](https://techdocs.akamai.com/etp/docs/sc-http-forwarder.md) - [Security Connector as a DNS sinkhole](https://techdocs.akamai.com/etp/docs/sc-dns-sinkhole.md) - [Supported versions](https://techdocs.akamai.com/etp/docs/sc-supported-versions.md) - [Set up the security connector](https://techdocs.akamai.com/etp/docs/setup-security-connector.md) - [Add a security connector](https://techdocs.akamai.com/etp/docs/add-security-connector.md) - [Download Security Connector](https://techdocs.akamai.com/etp/docs/download-security-connector.md) - [Deploy Security Connector](https://techdocs.akamai.com/etp/docs/deploy-security-connector.md) - [Create a security connector password](https://techdocs.akamai.com/etp/docs/create-sc-password.md) - [Configure the en2 interface](https://techdocs.akamai.com/etp/docs/configure-en2-interface.md) - [Configure the en1 interface](https://techdocs.akamai.com/etp/docs/configure-en1-interface.md) - [Configure DNS name servers](https://techdocs.akamai.com/etp/docs/configure-dns-nameservers.md) - [Select one or two interfaces for DNS or HTTP Forwarder data](https://techdocs.akamai.com/etp/docs/select-forwarder-interfaces.md) - [Generate an activation code](https://techdocs.akamai.com/etp/docs/generate-activation-code.md) - [Activate the security connector](https://techdocs.akamai.com/etp/docs/generate-activation-code1.md) - [Run a connectivity test](https://techdocs.akamai.com/etp/docs/run-connectivity-test.md) - [Assign security connectors to a policy](https://techdocs.akamai.com/etp/docs/assign-sc-policy.md) - [Test the security connector](https://techdocs.akamai.com/etp/docs/test-security-connector.md) - [Configure conditional forwarding](https://techdocs.akamai.com/etp/docs/configure-conditional-forwarding.md) - [Configure HTTP Forwarder](https://techdocs.akamai.com/etp/docs/configure-http-forwarder.md) - [Manage DNS Forwarder](https://techdocs.akamai.com/etp/docs/manage-dns-forwarder.md) - [View DNS Forwarder traffic statistics](https://techdocs.akamai.com/etp/docs/dns-forwarder-traffic.md) - [View DNS Forwarder health status](https://techdocs.akamai.com/etp/docs/dns-forwarder-health.md) - [Enable or disable query and response logging](https://techdocs.akamai.com/etp/docs/enable-disable-logging.md) - [Enable or disable DNS Forwarder](https://techdocs.akamai.com/etp/docs/enable-disable-forwarder.md) - [Change the DNS Forwarder DoT port](https://techdocs.akamai.com/etp/docs/change-dns-forwarder.md) - [Manage conditional forwarding rules](https://techdocs.akamai.com/etp/docs/manage-conditionalforwarding-rules.md) - [Enable the metrics exporter](https://techdocs.akamai.com/etp/docs/enable-metrics-exporter.md) - [Manage HTTP Forwarder](https://techdocs.akamai.com/etp/docs/manage-http-forwarder.md) - [Manage Security Connector](https://techdocs.akamai.com/etp/docs/manage-security-connector.md) - [Setup and virtual machine requirements](https://techdocs.akamai.com/etp/docs/setup-vm-reqs.md) - [Security Connector Web Console](https://techdocs.akamai.com/etp/docs/sc-web-console.md) - [Dashboard](https://techdocs.akamai.com/etp/docs/dashboard.md) - [Security Summary dashboard](https://techdocs.akamai.com/etp/docs/security-summary-dashboard.md) - [Manage the Security Summary dashboard](https://techdocs.akamai.com/etp/docs/manage-securitysummary-dashboard.md) - [Events](https://techdocs.akamai.com/etp/docs/events.md) - [Filter event data](https://techdocs.akamai.com/etp/docs/filter-event-data.md) - [Configure and apply a filter](https://techdocs.akamai.com/etp/docs/configure-apply-filter.md) - [Filter data based on date and time](https://techdocs.akamai.com/etp/docs/filter-data.md) - [Select a dimension](https://techdocs.akamai.com/etp/docs/select-a-dimension.md) - [Search for events](https://techdocs.akamai.com/etp/docs/search-for-events.md) - [View event details](https://techdocs.akamai.com/etp/docs/view-event-details.md) - [View domain details](https://techdocs.akamai.com/etp/docs/view-domain-details.md) - [View threat details](https://techdocs.akamai.com/etp/docs/view-threat-details.md) - [Add or remove data columns to events tables](https://techdocs.akamai.com/etp/docs/add-remove-datacolumns.md) - [Download a CSV file with event information](https://techdocs.akamai.com/etp/docs/download-event-information.md) - [Download CSV with aggregate data](https://techdocs.akamai.com/etp/docs/download-aggregate-data.md) - [Event dimensions](https://techdocs.akamai.com/etp/docs/event-dimensions.md) - [Threat event details](https://techdocs.akamai.com/etp/docs/threat-event-details.md) - [Access control event details](https://techdocs.akamai.com/etp/docs/ac-event-details.md) - [FWaaS event details](https://techdocs.akamai.com/etp/docs/fwaas-event-details.md) - [Activity](https://techdocs.akamai.com/etp/docs/activity.md) - [Summary of DNS activity](https://techdocs.akamai.com/etp/docs/summary-dns-activity.md) - [DNS activity](https://techdocs.akamai.com/etp/docs/dns-activity.md) - [Summary of Proxy activity](https://techdocs.akamai.com/etp/docs/summary-proxy-activity.md) - [Proxy activity](https://techdocs.akamai.com/etp/docs/proxy-activity.md) - [Network Traffic](https://techdocs.akamai.com/etp/docs/network-traffic.md) - [Security Connector activity](https://techdocs.akamai.com/etp/docs/security-connector-activity.md) - [Identity provider activity](https://techdocs.akamai.com/etp/docs/identity-provider-activity.md) - [IPsec tunnel activity](https://techdocs.akamai.com/etp/docs/ipsec-tunnel-activity.md) - [Indicator search](https://techdocs.akamai.com/etp/docs/indicator-search.md) - [Scheduled reports and notifications](https://techdocs.akamai.com/etp/docs/scheduled-reports.md) - [Transport data to your SIEM with Unified Log Streamer](https://techdocs.akamai.com/etp/docs/use-uls.md) - [Enterprise Threat Intelligence](https://techdocs.akamai.com/etp/docs/enterprise-threat-intelligence.md) - [SIA Configuration API](https://techdocs.akamai.com/etp/docs/etp-config-api.md) - [SIA Reporting API](https://techdocs.akamai.com/etp/docs/etp-reporting-api.md) - [SIA](https://techdocs.akamai.com/etp/docs/troubleshoot-etp.md) - [ETP Client](https://techdocs.akamai.com/etp/docs/troubleshoot-etp-client.md) - [Security Connector](https://techdocs.akamai.com/etp/docs/troubleshoot-security-connector.md) - [Troubleshoot connectivity test failures](https://techdocs.akamai.com/etp/docs/troubleshoot-test-failures.md) - [Security Connector status](https://techdocs.akamai.com/etp/docs/security-connector-status.md) - [Troubleshoot health status failures](https://techdocs.akamai.com/etp/docs/health-status-check.md) - [Resolve DNS Forwarder status failures](https://techdocs.akamai.com/etp/docs/dns-forwarder-status.md) - [Troubleshoot HTTP Forwarder](https://techdocs.akamai.com/etp/docs/troubleshoot-http-forwarder.md) - [Identity connector](https://techdocs.akamai.com/etp/docs/identity-connector.md) - [Grant access to Support](https://techdocs.akamai.com/etp/docs/grant-access-support.md) - [Known issues and limitations](https://techdocs.akamai.com/etp/docs/known-issues-limitations.md) ## Changelog - [Jun 24, 2026 — Security Connector 4.2.1 is now available](https://techdocs.akamai.com/etp/changelog/jun-24-2026-security-connector-421-is-now-available.md) - [Jun 17, 2026 — SIA updates](https://techdocs.akamai.com/etp/changelog/jun-17-2026-sia-updates.md) - [May 8, 2026 — SIA updates](https://techdocs.akamai.com/etp/changelog/may-8-2026-sia-updates.md) - [Mar 30, 2026 — Create custom error pages in SIA](https://techdocs.akamai.com/etp/changelog/mar-30-2026-create-custom-error-pages-in-sia.md) - [Feb 19, 2026 — Zero Trust Client for mobile devices](https://techdocs.akamai.com/etp/changelog/feb-19-zero-trust-client-for-mobile-devices.md) # SIA Configuration API Documentation > Akamai's Secure Internet Access (SIA) Configuration API offers a programmatic interface to manage policy settings to protect against enterprise security and acceptable user policy related events. A distributed configuration encapsulates all the rules for how to process DNS requests for your enterprise. ## API Reference - [Secure Internet Access Enterprise Configuration API v3](https://techdocs.akamai.com/etp-config/reference/api.md) - [API summary](https://techdocs.akamai.com/etp-config/reference/api-summary.md) - [Get started](https://techdocs.akamai.com/etp-config/reference/get-started.md) - [Get your configuration ID](https://techdocs.akamai.com/etp-config/reference/get-your-configuration-id.md) - [Rate Limiting](https://techdocs.akamai.com/etp-config/reference/rate-limiting.md) - [TLS certificates](https://techdocs.akamai.com/etp-config/reference/tls-certificates.md) - [Concurrency control](https://techdocs.akamai.com/etp-config/reference/concurrency-control.md) - [Timestamp formats](https://techdocs.akamai.com/etp-config/reference/timestamp-formats.md) - [Deployment status](https://techdocs.akamai.com/etp-config/reference/deployment-status.md) - [Certificate status](https://techdocs.akamai.com/etp-config/reference/certificate-status.md) - [List types](https://techdocs.akamai.com/etp-config/reference/list-types.md) - [API Concepts](https://techdocs.akamai.com/etp-config/reference/api-concepts.md) - [Errors](https://techdocs.akamai.com/etp-config/reference/api-errors.md) - [304](https://techdocs.akamai.com/etp-config/reference/304.md) - [400](https://techdocs.akamai.com/etp-config/reference/400.md) - [401](https://techdocs.akamai.com/etp-config/reference/401.md) - [403](https://techdocs.akamai.com/etp-config/reference/403.md) - [404](https://techdocs.akamai.com/etp-config/reference/404.md) - [405](https://techdocs.akamai.com/etp-config/reference/405.md) - [406](https://techdocs.akamai.com/etp-config/reference/406.md) - [409](https://techdocs.akamai.com/etp-config/reference/409.md) - [412](https://techdocs.akamai.com/etp-config/reference/412.md) - [429](https://techdocs.akamai.com/etp-config/reference/429.md) - [500](https://techdocs.akamai.com/etp-config/reference/500.md) - [Create a new proxy certificate](https://techdocs.akamai.com/etp-config/reference/post-customers-certificate.md): Creates a new proxy certificate. - [List proxy certificates](https://techdocs.akamai.com/etp-config/reference/get-customers-certificates.md): Returns a list of all available proxy certificates. - [Get a proxy certificate](https://techdocs.akamai.com/etp-config/reference/get-customers-certificate.md): Returns the details of the specified proxy certificate. - [Modify a proxy certificate](https://techdocs.akamai.com/etp-config/reference/put-customers-certificate.md): Updates the value of a proxy certificate. - [Activate a proxy certificate](https://techdocs.akamai.com/etp-config/reference/post-customers-certificate-activate.md): Transitions the proxy certificate's state from `PENDING_ACTIVATION` to `ACTIVE`. - [Confirm a proxy certificate's distribution](https://techdocs.akamai.com/etp-config/reference/post-certificate-confirm-distribution.md): Transitions the certificate's state from `PENDING_DISTRIBUTION` to `PENDING_ACTIVATION`. Only perform this operation after distributing the proxy certificates to relevant enterprise devices. - [Confirm a proxy certificate's download](https://techdocs.akamai.com/etp-config/reference/post-certificate-confirm-download.md): Transitions the certificate's state from `PENDING_DOWNLOAD` to `PENDING_ACTIVATION` or `INCOMPLETE`. - [Deactivate a proxy certificate](https://techdocs.akamai.com/etp-config/reference/post-certificate-deactivate.md): Transitions the proxy certificate's state from any state to `DEACTIVATING`. - [Create a new proxy certificate](https://techdocs.akamai.com/etp-config/reference/post-customers-certificate-1.md): Creates a new proxy certificate. - [List proxy certificates](https://techdocs.akamai.com/etp-config/reference/get-customers-certificates-1.md): Returns all available proxy certificates. - [Get a proxy certificate](https://techdocs.akamai.com/etp-config/reference/get-customers-certificate-1.md): Returns the details of the specified proxy certificate. - [Modify a proxy certificate](https://techdocs.akamai.com/etp-config/reference/put-customers-certificate-1.md): Updates the value of a proxy certificate. - [Activate a proxy certificate](https://techdocs.akamai.com/etp-config/reference/post-customers-certificate-activate-1.md): Transitions the proxy certificate's state from `PENDING_ACTIVATION` to `ACTIVE`. - [Confirm a proxy certificate's distribution](https://techdocs.akamai.com/etp-config/reference/post-certificate-confirm-distribution-1.md): Transitions the certificate's state from `PENDING_DISTRIBUTION` to `PENDING_ACTIVATION`. Only perform this operation after distributing the proxy certificates to relevant enterprise devices. - [Confirm a proxy certificate's download](https://techdocs.akamai.com/etp-config/reference/post-certificate-confirm-download-1.md): Transitions the certificate's state from `PENDING_DOWNLOAD` to `PENDING_ACTIVATION` or `INCOMPLETE`. - [Deactivate a proxy certificate](https://techdocs.akamai.com/etp-config/reference/post-certificate-deactivate-1.md): Transitions the proxy certificate's state from any state to `DEACTIVATING`. - [Create a policy](https://techdocs.akamai.com/etp-config/reference/post-policy.md): Creates a new policy. - [List policies](https://techdocs.akamai.com/etp-config/reference/get-policies.md): Returns all policies. - [Get a policy](https://techdocs.akamai.com/etp-config/reference/get-policy.md): Returns the details of a policy. - [Update a policy](https://techdocs.akamai.com/etp-config/reference/put-policy.md): Modifies the specified policy. - [Remove a policy](https://techdocs.akamai.com/etp-config/reference/delete-policy.md): Deletes the specified policy. - [Get policy metadata](https://techdocs.akamai.com/etp-config/reference/get-policy-metadata.md): Returns the policy metadata details. - [List built-in responses](https://techdocs.akamai.com/etp-config/reference/get-responses.md): Returns all available Akamai built-in responses. - [List security category predefined configurations](https://techdocs.akamai.com/etp-config/reference/get-security-categories.md): Returns all available predefined security categories. - [Create a DLP dictionary](https://techdocs.akamai.com/etp-config/reference/post-dictionary.md): Creates a DLP dictionary. - [List DLP dictionaries](https://techdocs.akamai.com/etp-config/reference/get-dictionaries.md): Lists all DLP dictionaries for the configuration. - [Get a DLP dictionary](https://techdocs.akamai.com/etp-config/reference/get-dictionary.md): Returns details of a DLP dictionary. - [Update a DLP dictionary](https://techdocs.akamai.com/etp-config/reference/put-dictionary.md): Updates a DLP dictionary. - [Remove a DLP dictionary](https://techdocs.akamai.com/etp-config/reference/delete-dictionary.md): Deletes a specific DLP dictionary. - [Create a DLP pattern](https://techdocs.akamai.com/etp-config/reference/post-patterns.md): Creates a DLP custom dictionary pattern. - [List DLP dictionary patterns](https://techdocs.akamai.com/etp-config/reference/get-patterns.md): Returns the DLP dictionary patterns. - [Get a DLP dictionary pattern](https://techdocs.akamai.com/etp-config/reference/get-pattern.md): Returns the specified DLP dictionary pattern. - [Delete a DLP dictionary pattern](https://techdocs.akamai.com/etp-config/reference/delete-pattern.md): Removes the specified DLP dictionary pattern. - [Create DLP regular expressions](https://techdocs.akamai.com/etp-config/reference/post-dlp-regexes.md): Creates DLP regular expressions. - [List DLP regular expressions](https://techdocs.akamai.com/etp-config/reference/get-dlp-regexes.md): Returns all DLP regular expressions. - [Get a DLP regular expression](https://techdocs.akamai.com/etp-config/reference/get-dlp-regex.md): Returns the specified DLP regular expression details. - [List configurations](https://techdocs.akamai.com/etp-config/reference/get-configs.md): Returns configuration IDs. Use this value for a `configId` parameter in subsequent operations. - [Onboard a contract](https://techdocs.akamai.com/etp-config/reference/post-config.md): Onboards the specified contract. - [Create an acknowledgment](https://techdocs.akamai.com/etp-config/reference/post-config-acknowledgment.md): Create an acknowledgment number for the configuration. - [Get an acknowledgment](https://techdocs.akamai.com/etp-config/reference/get-config-acknowledgment.md): Returns SIA keys. - [Get a custom error page](https://techdocs.akamai.com/etp-config/reference/get-custom-error-page.md): Gets the custom error page for the configuration. - [Update a custom error page](https://techdocs.akamai.com/etp-config/reference/put-custom-error-page.md): Updates the custom error page details. - [Get the first time wizard state](https://techdocs.akamai.com/etp-config/reference/get-firsttimewizard.md): Provides the first time wizard status. - [Update the first time wizard](https://techdocs.akamai.com/etp-config/reference/put-firsttimewizard.md): Updates the status of the first time wizard. - [Create a bulk log export destination config](https://techdocs.akamai.com/etp-config/reference/post-log-export-destination.md): Creates a bulk log export destination configuration, which includes three default export schedules. Supports Linode and Azure storage destinations. - [Get a bulk log export destination config](https://techdocs.akamai.com/etp-config/reference/get-log-export-destination.md): Retrieves the bulk log export destination configuration. - [List bulk log export schedule configurations](https://techdocs.akamai.com/etp-config/reference/get-log-export-schedules.md): Returns all bulk log export schedule configurations. - [Disable a bulk log export schedule](https://techdocs.akamai.com/etp-config/reference/post-disable-log-export-schedule.md): Disables a bulk log export schedule. Schedules are disabled by default. - [Enable a bulk log export schedule](https://techdocs.akamai.com/etp-config/reference/post-enable-log-export-schedule.md): Enables a bulk log export schedule. Schedules are disabled by default. - [Update a bulk log export destination config](https://techdocs.akamai.com/etp-config/reference/post-update-log-export-destination.md): Updates the bulk log export destination configuration. - [Create a group-based policy mapping](https://techdocs.akamai.com/etp-config/reference/post-group-policy.md): Creates a group-based policy mapping. - [List group-based policy mappings](https://techdocs.akamai.com/etp-config/reference/get-group-policy-mappings.md): Returns all group-based policies. - [Delete all group policy mappings for an IDP](https://techdocs.akamai.com/etp-config/reference/delete-group-policies-for-idp.md): Deletes all group policy mappings for an IDP. - [Get a group-based policy mapping](https://techdocs.akamai.com/etp-config/reference/get-group-policy.md): Gets a group-based policy mapping. - [Update a group-based policy mapping](https://techdocs.akamai.com/etp-config/reference/put-group-policy.md): Update a group-based policy mapping. - [Delete a group-based policy mapping](https://techdocs.akamai.com/etp-config/reference/delete-group-policy.md): Deletes a group-based policy mapping. - [Create a security connector](https://techdocs.akamai.com/etp-config/reference/post-security-connector.md): Creates a security connector. - [List security connectors](https://techdocs.akamai.com/etp-config/reference/get-security-connectors.md): Returns security connectors. - [List the current security connector versions](https://techdocs.akamai.com/etp-config/reference/get-security-connectors-latest-version.md): Provides the current version of the security connectors. - [Get the security connector's latest available version](https://techdocs.akamai.com/etp-config/reference/get-security-connector-latest-versions.md): Provides the latest available version for the security connector. - [Get a security connector](https://techdocs.akamai.com/etp-config/reference/get-security-connector.md): Returns the details of a specific security connector. - [Delete a security connector](https://techdocs.akamai.com/etp-config/reference/delete-security-connector.md): Deletes the specified security connector. Add an `If-Match` header to prevent deleting any data another client has modified since you last accessed it. - [Change a local security connector password](https://techdocs.akamai.com/etp-config/reference/post-security-connector-change-local-password.md): Changes the local password for the specified security connector. - [Generate an activation code for a security connector](https://techdocs.akamai.com/etp-config/reference/post-security-connector-generate-activation-code.md): Generates the activation code for a security connector. - [Upgrade a security connector](https://techdocs.akamai.com/etp-config/reference/post-security-connector-upgrade.md): Upgrades software of a specific security connector. - [Update a security connector](https://techdocs.akamai.com/etp-config/reference/put-security-connector.md): Modifies details of the current security connector. - [Create a configuration deployment](https://techdocs.akamai.com/etp-config/reference/post-deployment.md): Creates a new configuration deployment. - [List configuration deployments](https://techdocs.akamai.com/etp-config/reference/get-deployments.md): Returns a history of deployments for the current configuration. - [Get a configuration deployment](https://techdocs.akamai.com/etp-config/reference/get-deployment.md): Returns details of a specific configuration deployment. - [List deployment changes](https://techdocs.akamai.com/etp-config/reference/get-deployment-diff.md): Provides details of deployment changes. - [List recent changes](https://techdocs.akamai.com/etp-config/reference/get-config-recent-changes.md): Returns all changes made since the last configuration deployment. - [Create a custom response](https://techdocs.akamai.com/etp-config/reference/post-custom-response.md): Creates a new custom response. - [List custom responses](https://techdocs.akamai.com/etp-config/reference/get-custom-responses.md): Returns all custom responses. - [Get a custom response](https://techdocs.akamai.com/etp-config/reference/get-custom-response.md): Returns the details of a specific custom response. - [Update a custom response](https://techdocs.akamai.com/etp-config/reference/put-custom-response.md): Modifies a custom response's features. - [Delete a custom response](https://techdocs.akamai.com/etp-config/reference/delete-custom-response.md): Deletes a specific custom response. - [List DNS VIPs](https://techdocs.akamai.com/etp-config/reference/get-dns-vips.md): Provides DNS virtual IP details. - [Get global settings](https://techdocs.akamai.com/etp-config/reference/get-global-settings.md): Provides global settings details. - [Update global settings](https://techdocs.akamai.com/etp-config/reference/put-global-settings.md): Updates the global settings. - [Create a site](https://techdocs.akamai.com/etp-config/reference/post-sites.md): Creates a new site. - [List sites](https://techdocs.akamai.com/etp-config/reference/get-sites.md): Returns all sites for a configuration. - [Get site metadata](https://techdocs.akamai.com/etp-config/reference/get-sites-meta-info.md): Provides site meta info details. - [Bulk create sites](https://techdocs.akamai.com/etp-config/reference/post-sites-bulk-upload.md): Uploads sites in bulk using a CSV file: - maximum of 100 sites per file - supports comma-delimited or tab-delimited files - must include all headers in the file. - [Get a site](https://techdocs.akamai.com/etp-config/reference/get-site.md): Returns the details of a specific Site. - [Update a site](https://techdocs.akamai.com/etp-config/reference/put-site.md): Modifies site details. - [Assign a policy to a site](https://techdocs.akamai.com/etp-config/reference/post-sublocation-policy.md): Assigns a policy to the site. - [Remove a site](https://techdocs.akamai.com/etp-config/reference/delete-site.md): Deletes a specific site. Add an `If-Match` header to prevent deleting any data another client has modified since you last accessed it. - [Create a sublocation](https://techdocs.akamai.com/etp-config/reference/post-site-sublocation.md): Creates a sublocation. - [List sublocations](https://techdocs.akamai.com/etp-config/reference/get-site-sublocations.md): Returns the list of sublocations for the site. - [Get a sublocation](https://techdocs.akamai.com/etp-config/reference/get-site-sublocation.md): Returns a sublocation detail. - [Update a sublocation](https://techdocs.akamai.com/etp-config/reference/put-site-sublocation.md): Updates the sublocation. - [Remove a sublocation](https://techdocs.akamai.com/etp-config/reference/delete-site-sublocation.md): Deletes a specific sublocation. Add an `If-Match` header to prevent deleting any data another client has modified since you last accessed it. - [Get a client configuration](https://techdocs.akamai.com/etp-config/reference/get-client-configuration.md): Provides client configuration details. - [Update a client configuration](https://techdocs.akamai.com/etp-config/reference/put-client-configuration.md): Updates the client configuration. - [List client versions](https://techdocs.akamai.com/etp-config/reference/get-client-versions.md): Provides client versions. - [Rotate the client version entitlement code](https://techdocs.akamai.com/etp-config/reference/post-rotate-entitlement-code.md): Rotates global entitlement code. - [Update a client version](https://techdocs.akamai.com/etp-config/reference/put-client-version.md): Updates the details of the specific client version. - [Download a client version](https://techdocs.akamai.com/etp-config/reference/get-client-version-download.md): Provides the link to download client version details. - [List client devices](https://techdocs.akamai.com/etp-config/reference/get-client-devices.md): Provides client devices and their details. - [Deactivate a client device](https://techdocs.akamai.com/etp-config/reference/post-device-de-activate.md): Deactivates the specified client device. - [Re-activate a client device](https://techdocs.akamai.com/etp-config/reference/post-device-re-activate.md): Re-activates the specified device. - [Get client status](https://techdocs.akamai.com/etp-config/reference/get-client-status.md): Provides details of software installed with device counts. Also specifies errors and device count with errors. - [Create a network configuration](https://techdocs.akamai.com/etp-config/reference/post-network-configuration.md): Creates the network configuration. - [Get the network configuration](https://techdocs.akamai.com/etp-config/reference/get-network-configuration.md): Provides network configuration details. - [Update the network configuration](https://techdocs.akamai.com/etp-config/reference/put-network-configuration.md): Modifies the network configuration. - [Create notifications configs](https://techdocs.akamai.com/etp-config/reference/post-notifications-config.md): Create notification configs in bulk. - [List notification configurations](https://techdocs.akamai.com/etp-config/reference/get-notifications-config.md): Provides all notification configurations. - [Update notification configurations](https://techdocs.akamai.com/etp-config/reference/put-notifications-config.md): Updates the notification configs in bulk. - [Get notification configuration for type](https://techdocs.akamai.com/etp-config/reference/get-config-notification-type.md): Gets notification details for the given notification type. - [Update the subscribers to notification type](https://techdocs.akamai.com/etp-config/reference/put-config-notification-type.md): Updates the subscribers to the given notification type. - [Create a list](https://techdocs.akamai.com/etp-config/reference/post-list.md): Creates a new list. - [List all lists](https://techdocs.akamai.com/etp-config/reference/get-lists.md): Returns all available custom security lists. - [List global list quotas](https://techdocs.akamai.com/etp-config/reference/get-lists-quota.md): Returns the remaining list item quota for all lists globally. - [Get details of a list](https://techdocs.akamai.com/etp-config/reference/get-list.md): Returns the details of a specific list. - [Update a list](https://techdocs.akamai.com/etp-config/reference/put-config-list.md): Modifies list properties and all items for a specific list. Full update only. - [Remove a list](https://techdocs.akamai.com/etp-config/reference/delete-config-list.md): Deletes a specific list. - [Search in a list](https://techdocs.akamai.com/etp-config/reference/get-config-lists-items.md): Filters items in a list by search parameters. - [Modify list items](https://techdocs.akamai.com/etp-config/reference/put-config-lists-items.md): Updates list items (overwrite). - [Patch a list](https://techdocs.akamai.com/etp-config/reference/patch-config-list.md): Modifies individual list items entries. Add or delete only. - [List all Akamai built-in security lists](https://techdocs.akamai.com/etp-config/reference/get-akamai-lists.md): Returns all available Akamai built-in lists. - [Clear the DNS cache](https://techdocs.akamai.com/etp-config/reference/post-dns-cache.md): Clears the DNS cache for the specified domain. - [Create a VPN credential](https://techdocs.akamai.com/etp-config/reference/post-vpn-credentials.md): Creates a new VPN credential. - [List VPN credentials](https://techdocs.akamai.com/etp-config/reference/get-vpn-credentials.md): Provides all VPN credentials. - [Get a VPN credential](https://techdocs.akamai.com/etp-config/reference/get-vpn-credential-details.md): Provides details for the specified VPN credential. - [Delete a VPN credential](https://techdocs.akamai.com/etp-config/reference/delete-vpn-credential.md): Deletes the specified VPN credential. - [Create a proxy credential](https://techdocs.akamai.com/etp-config/reference/post-proxy-credential.md): Creates a new proxy credential. - [List proxy credentials](https://techdocs.akamai.com/etp-config/reference/get-proxy-credentials.md): Provides list of proxy credentials. - [Get a proxy credential](https://techdocs.akamai.com/etp-config/reference/get-proxy-credential.md): Provides the proxy credential info for the specified `userName`. - [Remove a proxy credential](https://techdocs.akamai.com/etp-config/reference/delete-proxy-credential.md): Deletes a specific proxy credential. - [Onboard a tenant](https://techdocs.akamai.com/etp-config/reference/post-onboard-tenant.md): Onboards a new Tenant. - [List all tenants](https://techdocs.akamai.com/etp-config/reference/get-tenants.md): Returns all tenants. - [Get a tenant](https://techdocs.akamai.com/etp-config/reference/get-tenant.md): Returns a tenant details. - [Update a tenant](https://techdocs.akamai.com/etp-config/reference/put-tenant.md): Updates the specified tenant. - [Remove a tenant](https://techdocs.akamai.com/etp-config/reference/delete-tenant.md): Deletes a specific tenant. - [List tenant users](https://techdocs.akamai.com/etp-config/reference/get-tenant-users.md): Lists details of users assigned to a tenant. ## Changelog - [Apr 28, 2023 — Sinkholes and Honeypots renamed](https://techdocs.akamai.com/etp-config/changelog/april-28-new-sites-feature-sinkholes-and-honeypots-renamed.md) - [Mar 10, 2023 — ETP Configuration and Reporting API v1/v2 Decommission Notice](https://techdocs.akamai.com/etp-config/changelog/etp-api-v1-eol-notice.md) - [Jan 21, 2022 — New ETP Configuration API documentation experience](https://techdocs.akamai.com/etp-config/changelog/jan-21-2022-new-etp-config-api-documentation-experience.md) # SIA Reporting API Documentation > The Secure Internet Access (SIA) Reporting API lets you access and analyze reports for security events, acceptable user policy events, and DNS activity totals. You can also view Indicator of Compromise (IOC) data to further analyze blacklisted entries. The API allows you flexible access to the same reporting features as in Akamai Control Center, using your own tools. ## API Reference - [Secure Internet Access Enterprise Reporting API v3](https://techdocs.akamai.com/etp-reporting/reference/api.md) - [API summary](https://techdocs.akamai.com/etp-reporting/reference/api-summary.md) - [Get started](https://techdocs.akamai.com/etp-reporting/reference/get-started.md) - [API concepts](https://techdocs.akamai.com/etp-reporting/reference/api-concepts.md) - [Timestamp formats](https://techdocs.akamai.com/etp-reporting/reference/timestamp-formats.md) - [Report scheduling](https://techdocs.akamai.com/etp-reporting/reference/report-scheduling.md) - [Rate Limiting](https://techdocs.akamai.com/etp-reporting/reference/rate-limiting.md) - [Filters object](https://techdocs.akamai.com/etp-reporting/reference/filters.md) - [Errors](https://techdocs.akamai.com/etp-reporting/reference/errors.md) - [304](https://techdocs.akamai.com/etp-reporting/reference/304.md) - [400](https://techdocs.akamai.com/etp-reporting/reference/400.md) - [403](https://techdocs.akamai.com/etp-reporting/reference/403.md) - [404](https://techdocs.akamai.com/etp-reporting/reference/404.md) - [Filter Onramp types](https://techdocs.akamai.com/etp-reporting/reference/onramp-types.md) - [Report threat event totals](https://techdocs.akamai.com/etp-reporting/reference/get-threat-events.md): Lists the count of threat events, grouped by the chosen query aggregation. - [Report threat event details](https://techdocs.akamai.com/etp-reporting/reference/post-threat-event-details.md): Provides all threat events records with detailed information. - [Report threat event time series](https://techdocs.akamai.com/etp-reporting/reference/get-threat-event-time-series.md): Lists threat event totals, aggregated by hour. - [Report AUP event totals](https://techdocs.akamai.com/etp-reporting/reference/get-aup-events.md): Lists total counts for AUP events, aggregated for the given time period. - [Report AUP event details](https://techdocs.akamai.com/etp-reporting/reference/post-events-details.md): Provides all threat events record details for a given time period. - [Report AUP event time series](https://techdocs.akamai.com/etp-reporting/reference/get-events-time-series.md): Lists total counts for AUP events, aggregated by hour. - [Report DNS activity totals](https://techdocs.akamai.com/etp-reporting/reference/get-dns-activities.md): Lists the count of DNS activities aggregated for the given time period. - [Report DNS activity event details](https://techdocs.akamai.com/etp-reporting/reference/post-dns-activities-details.md): Lists raw DNS events for a given time period. This operation Lists the first 500 configurable results. - [Report DNS activity time series](https://techdocs.akamai.com/etp-reporting/reference/get-dns-activities-time-series.md): Lists the count of DNS activities, aggregated by hour. - [Report security connector event totals](https://techdocs.akamai.com/etp-reporting/reference/get-sinkhole-events.md): Lists the count of Security Connector events, grouped by the chosen query aggregation. - [Report security connector event details](https://techdocs.akamai.com/etp-reporting/reference/post-sinkhole-event-details.md): Lists Security Connector events for a given time period. - [Report security connector event time series](https://techdocs.akamai.com/etp-reporting/reference/get-sinkhole-events-time-series.md): Lists Security Connector event totals, aggregated by hour. - [Report IDP access log details](https://techdocs.akamai.com/etp-reporting/reference/post-access-logs-details.md): Lists the IDP access logs for a configuration for a given time period. - [Get IOC time series report](https://techdocs.akamai.com/etp-reporting/reference/get-time-series.md): Lists the DNS activities of a configuration for a given domain or IP, aggregated by day. Omit `startTimeSec` and `endTimeSec` from the request URL to return all available historical information. - [Get IOC change report](https://techdocs.akamai.com/etp-reporting/reference/get-ioc-changes.md): Lists historical change information for a given record and record type. Omit `startTimeSec` and `endTimeSec` from the request URL to return all available historical information. - [Get IOC AVC details report](https://techdocs.akamai.com/etp-reporting/reference/get-ioc-details-avc.md): Lists the AVC details for a given domain or IP. - [Get IOC CIDR details report](https://techdocs.akamai.com/etp-reporting/reference/get-ioc-details-cidr.md): Lists the CIDR details for a given domain or IP. - [Get IOC domain tree report](https://techdocs.akamai.com/etp-reporting/reference/get-ioc-domain-tree.md): Lists the blocklisted domains and IPs matching a given record. Returns an empty list if no domains match. - [Get IOC details report](https://techdocs.akamai.com/etp-reporting/reference/get-ioc-details.md): Lists the IOC details for a given domain or IP. - [Get IOC AUP detail report](https://techdocs.akamai.com/etp-reporting/reference/get-ioc-details-aup.md): Lists the AUP details for a given domain or IP. - [Get deepscan details report](https://techdocs.akamai.com/etp-reporting/reference/get-scan-reports.md): Deepscan results for a configuration's offline network for a given time period. Use the path obtained from `/threat-events`. - [Get threat metadata report](https://techdocs.akamai.com/etp-reporting/reference/get-threat-metadata.md): Returns the threat metadata. - [Report a threat](https://techdocs.akamai.com/etp-reporting/reference/post-feedback-details.md): Reports the threat for a domain. - [Get feedback event detail report](https://techdocs.akamai.com/etp-reporting/reference/get-feedbacks-details.md): Returns feedback information about a domain based on the feedback type. - [Create a report schedule](https://techdocs.akamai.com/etp-reporting/reference/post-config-schedule.md): Creates a new report schedule for a given SIA configuration. - [List report schedules](https://techdocs.akamai.com/etp-reporting/reference/get-config-schedules.md): Lists all configured report schedules for a given configuration. - [Get a report schedule](https://techdocs.akamai.com/etp-reporting/reference/get-config-schedule.md): Lists the configuration of a specified report schedule. - [Update a report schedule](https://techdocs.akamai.com/etp-reporting/reference/put-config-schedule.md): Updates the configuration of a specified report schedule. - [Remove a report schedule](https://techdocs.akamai.com/etp-reporting/reference/delete-config-schedule.md): Removes the configuration of a specified report schedule. - [Disable a report schedule](https://techdocs.akamai.com/etp-reporting/reference/post-config-schedule-disable.md): Disables the configuration of a specified report schedule. - [Enable a report schedule](https://techdocs.akamai.com/etp-reporting/reference/post-config-schedule-enable.md): Enables the configuration of a specified report schedule. - [Report network traffic connections totals](https://techdocs.akamai.com/etp-reporting/reference/get-network-traffic-connections.md): Lists the count of network traffic connections totals, grouped by query parameters. - [Report network traffic connections details](https://techdocs.akamai.com/etp-reporting/reference/post-network-traffic-connections-details.md): Lists network traffic connections for a given time period. - [Report network traffic connections time series](https://techdocs.akamai.com/etp-reporting/reference/get-connections-time-series.md): Lists network traffic connections totals, aggregated by hour. - [Report proxy traffic transactions totals](https://techdocs.akamai.com/etp-reporting/reference/get-proxy-traffic-transactions.md): Lists the count of proxy traffic transaction totals, grouped by the chosen query aggregation.. - [Report proxy network traffic transaction details](https://techdocs.akamai.com/etp-reporting/reference/post-traffic-transaction-details.md): Lists proxy network traffic connections for a given time period. - [Report proxy traffic transactions time series](https://techdocs.akamai.com/etp-reporting/reference/get-traffic-transactions-time-series.md): Lists proxy traffic transaction totals, aggregated by hour. - [Get latest domain threat intelligence](https://techdocs.akamai.com/etp-reporting/reference/get-threat-intel.md): Checks for new threat intelligence dataset. If new data is available, returns a short-lived pre-signed URL. ## Changelog - [Aug 6, 2025 - Threat intelligence feed delivery](https://techdocs.akamai.com/etp-reporting/changelog/aug-6-2025-threat-intelligence-feed-delivery.md) - [Jan 21, 2022 — New ETP Reporting API documentation experience](https://techdocs.akamai.com/etp-reporting/changelog/jan-21-2022-new-etp-reporting-api-documentation-experience.md) # SIEM Integration Documentation > Akamai’s SIEM Integration Solution integrates third-party Security Information and Event Management (SIEM) applications with Akamai Security Business Unit solutions including Kona Site Defender, Bot Manager, Client Reputation, and Web Application Protector. This solution lets customers choose security configurations and firewall policies that capture and filter security events based on an attack category. Cloud Security customers can leverage pre-built connectors with Splunk, HP ArchSight, IBM QRadar, and Intel McAfee SIEM applications. They can also develop their own custom connector for specific SIEM solutions. The SIEM connector uses an Akamai API to pull security events data into the SIEM application securely and in real time. ## Guides - [Welcome to SIEM Integration](https://techdocs.akamai.com/siem-integration/docs/welcome-siem-integration.md) - [SIEM Integration](https://techdocs.akamai.com/siem-integration/docs/akamai-siem-integration-for-splunk-and-cef-syslog.md) - [SIEM CEF connector](https://techdocs.akamai.com/siem-integration/docs/siem-cef-connector.md) - [SIEM Splunk connector](https://techdocs.akamai.com/siem-integration/docs/siem-splunk-connector.md) ## API Reference - [SIEM Integration API](https://techdocs.akamai.com/siem-integration/reference/api.md) - [API summary](https://techdocs.akamai.com/siem-integration/reference/api-summary.md) - [Get started](https://techdocs.akamai.com/siem-integration/reference/api-get-started.md) - [Query modes](https://techdocs.akamai.com/siem-integration/reference/query-parameter-combinations.md) - [Rate limits](https://techdocs.akamai.com/siem-integration/reference/rate-limits.md) - [Multi-JSON responses](https://techdocs.akamai.com/siem-integration/reference/multi-json-response-format-1.md) - [Configuration rule data](https://techdocs.akamai.com/siem-integration/reference/configuration-rule.md) - [Offset context](https://techdocs.akamai.com/siem-integration/reference/offsetcontext.md) - [Errors](https://techdocs.akamai.com/siem-integration/reference/errors.md) - [400](https://techdocs.akamai.com/siem-integration/reference/400.md) - [403](https://techdocs.akamai.com/siem-integration/reference/403.md) - [404](https://techdocs.akamai.com/siem-integration/reference/404.md) - [416](https://techdocs.akamai.com/siem-integration/reference/416.md) - [428](https://techdocs.akamai.com/siem-integration/reference/428.md) - [429](https://techdocs.akamai.com/siem-integration/reference/429.md) - [500](https://techdocs.akamai.com/siem-integration/reference/500.md) - [503](https://techdocs.akamai.com/siem-integration/reference/503.md) - [Fetch security events](https://techdocs.akamai.com/siem-integration/reference/get-config.md): Get security events data from your security configurations using one of two modes: [offset or time-based](https://techdocs.akamai.com/siem-integration/reference/query-parameter-combinations). Each mode orders event logs based on the logs' storage time in the database, not the time when the events actually occurred. This may result in delayed event logs in subsequent offset requests, or older event logs in time-based requests. While both methods have a 5-second latency, using `offset` allows subsequent calls to return logs for the 5 seconds omitted from the previous request. The time-based method omits logs from that 5 seconds of latency, so you may miss some logs from that period. If the connection is disrupted, use time-based mode to replay security events that occurred in the last 12 hours up to 5 seconds before your requested time range. Use `offset` and `limit` parameters in offset mode. Use `from`, `to`, and `limit` parameters in time-based mode. The potentially large response contains a series of JSON objects, each separated with a line break and each corresponding to a security event. The last line of the response is an [offset context](https://techdocs.akamai.com/siem-integration/reference/offsetcontext) object that provides `total` records fetched, an `offset` to use a starting point for the next batch of data, and any `limit` you specified. Run this operation continuously as long as it returns new logs to ensure you don't miss any. The API may return a maximum of 600,000 logs per request, while your configurations might generate many more in periods of high traffic. ## Recipes - [Fetch security event in time-based mode](https://techdocs.akamai.com/siem-integration/recipes/fetch-security-event-in-time-based-mode.md) - [Fetch security events in offset mode](https://techdocs.akamai.com/siem-integration/recipes/fetch-security-events-in-offset-mode.md) ## Changelog - [Jul 2026 — New versions of Splunk(v1.4.24) and CEF(v1.7.14) connectors now available](https://techdocs.akamai.com/siem-integration/changelog/jul-2026-new-versions-of-splunkv1424-and-cefv1714-connectors-now-available.md) - [Apr 30, 2026 — Geographic data updated](https://techdocs.akamai.com/siem-integration/changelog/apr-30-2026-geographic-data-updated.md) - [Apr 2026 — CEF connector 1.7.13.1](https://techdocs.akamai.com/siem-integration/changelog/apr-2026-cef-connector-17131.md) - [Feb 2026 — Firewall for AI integration](https://techdocs.akamai.com/siem-integration/changelog/feb-2026-firewall-for-ai-integration.md) - [Feb 2026 — New versions of Splunk and CEF connectors now available](https://techdocs.akamai.com/siem-integration/changelog/feb-2026-new-versions-of-splunk-and-cef-connectors-now-available.md) # Single Sign-On Configuration API Documentation > Akamai's Single Sign-On Configuration API lets you manage SSO with SAML certificates. ## API Reference - [Single Sign-On Configuration API](https://techdocs.akamai.com/sso-config/reference/api.md) - [API summary](https://techdocs.akamai.com/sso-config/reference/api-summary.md) - [Get started](https://techdocs.akamai.com/sso-config/reference/get-started.md) - [Errors](https://techdocs.akamai.com/sso-config/reference/errors.md) - [400](https://techdocs.akamai.com/sso-config/reference/400.md) - [401](https://techdocs.akamai.com/sso-config/reference/401.md) - [403](https://techdocs.akamai.com/sso-config/reference/403.md) - [404](https://techdocs.akamai.com/sso-config/reference/404.md) - [405](https://techdocs.akamai.com/sso-config/reference/405.md) - [406](https://techdocs.akamai.com/sso-config/reference/406.md) - [415](https://techdocs.akamai.com/sso-config/reference/415.md) - [500](https://techdocs.akamai.com/sso-config/reference/500.md) - [503](https://techdocs.akamai.com/sso-config/reference/503.md) - [Add a certificate](https://techdocs.akamai.com/sso-config/reference/post-certificate.md): This operation adds the `certificate` to the IdP. - [List certificates](https://techdocs.akamai.com/sso-config/reference/get-certificates.md): This operation lists the certificates from the IdP. - [Remove a certificate](https://techdocs.akamai.com/sso-config/reference/delete-certificate.md): This operation deletes the `certificate` from your account's IdP. ## Changelog - [Aug 23, 2023 — Single Sign-On Configuration API](https://techdocs.akamai.com/sso-config/changelog/aug-15-2023-single-sign-on-configuration-api-release.md) # Site Shield Documentation > Site Shield provides an additional layer of defense for critical websites and web applications. Site Shield cloaks websites from the public Internet, effectively removing them from Internet-accessible IP address space. This helps prevent attackers from directly targeting the application origin and forces traffic to go through the Akamai Intelligent Platform, where attacks can be detected and mitigated. ## Guides - [Welcome to Site Shield](https://techdocs.akamai.com/site-shield/docs/welcome-site-shield.md) - [Create a Site Shield map](https://techdocs.akamai.com/site-shield/docs/create-a-site-shield-map.md) - [Add the Site Shield behavior to your properties](https://techdocs.akamai.com/site-shield/docs/add-the-site-shield-behavior-to-your-properties.md) - [Allow Site Shield IP addresses through your firewall](https://techdocs.akamai.com/site-shield/docs/allow-site-shield-ip-addresses-through-your-firewall.md) - [Update your firewall with the latest IP addresses](https://techdocs.akamai.com/site-shield/docs/update-your-firewall-with-the-latest-ip-addresses.md) - [View map activity log](https://techdocs.akamai.com/site-shield/docs/view-map-activity-log.md) - [Edit a Site Shield map](https://techdocs.akamai.com/site-shield/docs/edit-a-site-shield-map.md) - [Maintenance expectations](https://techdocs.akamai.com/site-shield/docs/maintenance.md) - [Firewall updates and address change acknowledgment](https://techdocs.akamai.com/site-shield/docs/updating-your-firewall-and-acknowledging-address-changes.md) - [Site Shield map information updates](https://techdocs.akamai.com/site-shield/docs/editing-a-site-shield-map-information.md) - [Test Site Shield Map CIDRs](https://techdocs.akamai.com/site-shield/docs/test-cidrs.md) - [Create a test profile](https://techdocs.akamai.com/site-shield/docs/create-a-test-profile.md) - [Bulk import of origin details](https://techdocs.akamai.com/site-shield/docs/bulk-import-of-origin-details.md) - [Run a test](https://techdocs.akamai.com/site-shield/docs/run-a-test.md) - [Review test results](https://techdocs.akamai.com/site-shield/docs/interpret-test-results.md) - [Allow staging IP addresses through your firewall](https://techdocs.akamai.com/site-shield/docs/allow-staging-ip-addresses-through-your-firewall.md) - [Site Shield Stable CIDRs overview](https://techdocs.akamai.com/site-shield/docs/site-shield-stable-cidrs-overview.md) - [Enable Site Shield Stable CIDRs](https://techdocs.akamai.com/site-shield/docs/enable-site-shield-stable-cidrs.md) - [Stay in Original mode](https://techdocs.akamai.com/site-shield/docs/stay-in-original-mode.md) - [Stable CIDRs rollback](https://techdocs.akamai.com/site-shield/docs/stable-cidrs-rollback.md): After you update your Site Shield map to Stable CIDRs, you can roll back to your previous set of CIDRs within a 7-day period. - [Akamai CLI](https://techdocs.akamai.com/site-shield/docs/site-shield-cli.md) - [Site Shield API](https://techdocs.akamai.com/site-shield/docs/site-shield-api.md) ## API Reference - [Site Shield API](https://techdocs.akamai.com/site-shield/reference/api.md) - [API summary](https://techdocs.akamai.com/site-shield/reference/api-summary.md) - [Get started](https://techdocs.akamai.com/site-shield/reference/api-get-started.md) - [Rate limits](https://techdocs.akamai.com/site-shield/reference/rate-limits.md) - [Errors](https://techdocs.akamai.com/site-shield/reference/errors.md) - [401](https://techdocs.akamai.com/site-shield/reference/401.md) - [403](https://techdocs.akamai.com/site-shield/reference/403.md) - [404](https://techdocs.akamai.com/site-shield/reference/404.md) - [500](https://techdocs.akamai.com/site-shield/reference/500.md) - [List maps](https://techdocs.akamai.com/site-shield/reference/get-maps.md): Returns a list of all Site Shield maps that belong to your account. - [Get a map](https://techdocs.akamai.com/site-shield/reference/get-map.md): Returns information about the specified map, such as the map name, firewall addresses, and when the map was last updated. - [Acknowledge the map](https://techdocs.akamai.com/site-shield/reference/post-map-acknowledge.md): Acknowledges the proposed firewall update for the specified map. When necessary, the Site Shield Management application issues an update to the IP address list and sends a notification to you to update your firewall. See [Firewall updates and address change acknowledgment](doc:updating-your-firewall-and-acknowledging-address-changes) for more details. ## Recipes - [Acknowledge a map](https://techdocs.akamai.com/site-shield/recipes/acknowledge-a-map.md) - [Get a map](https://techdocs.akamai.com/site-shield/recipes/get-a-map.md) - [List maps](https://techdocs.akamai.com/site-shield/recipes/list-maps.md) ## Changelog - [Sept 20, 2023 — New Site Shield stable CIDR feature](https://techdocs.akamai.com/site-shield/changelog/sept-20-2022-new-site-shield-stable-cidr-feature.md) - [Dec 2, 2021 — New Site Shield documentation experience](https://techdocs.akamai.com/site-shield/changelog/dec-2021-new-site-shield-documentation-experience.md) - [Sep 1, 2017 — Default period for Site Shield map changes](https://techdocs.akamai.com/site-shield/changelog/efault-period-for-site-shield-map-changes.md) - [Aug 1, 2017 — Default period for Site Shield map changes](https://techdocs.akamai.com/site-shield/changelog/aug-01-2017-default-period-for-site-shield-map-changes.md) - [Mar 1, 2017 — Error in previous release note](https://techdocs.akamai.com/site-shield/changelog/mar-1-2017-error-in-previous-release-note.md) # Terraform Documentation > Use Infrastructure as Code to manage and provision your Akamai configurations. ## Guides - [Breaking changes](https://techdocs.akamai.com/terraform/docs/breaking-changes.md): v10.0 - [Overview](https://techdocs.akamai.com/terraform/docs/overview.md) - [Alternative authentication](https://techdocs.akamai.com/terraform/docs/gs-authentication.md) - [Environment variables](https://techdocs.akamai.com/terraform/docs/environment-variables.md) - [Base IDs](https://techdocs.akamai.com/terraform/docs/common-identifiers.md) - [Import and export assets](https://techdocs.akamai.com/terraform/docs/import-and-export-assets.md) - [Request limits](https://techdocs.akamai.com/terraform/docs/request-limits.md): Preventing 429s - [Create identities and control access](https://techdocs.akamai.com/terraform/docs/set-up-iam.md) - [Accessible groups](https://techdocs.akamai.com/terraform/docs/iam-ds-access-grps.md): akamai_iam_accessible_groups - [Account switch keys](https://techdocs.akamai.com/terraform/docs/iam-ds-asks.md): akamai_iam_account_switch_keys - [Allowed APIs](https://techdocs.akamai.com/terraform/docs/iam-ds-allowed-apis.md): akamai_iam_allowed_apis - [API client](https://techdocs.akamai.com/terraform/docs/iam-ds-api-client.md): akamai_iam_api_client - [API clients](https://techdocs.akamai.com/terraform/docs/iam-ds-api-clients.md): akamai_iam_api_clients - [Authorized users](https://techdocs.akamai.com/terraform/docs/iam-ds-auth-users.md): akamai_iam_authorized_user - [Blocked properties](https://techdocs.akamai.com/terraform/docs/iam-ds-blocked-props.md): akamai_iam_blocked_properties - [CIDR block](https://techdocs.akamai.com/terraform/docs/iam-ds-cidr-block.md): akamai_iam_cidr_block - [CIDR blocks](https://techdocs.akamai.com/terraform/docs/iam-ds-cidr-blocks.md): akamai_iam_cidr_blocks - [Contact types](https://techdocs.akamai.com/terraform/docs/iam-ds-contact-types.md): akamai_iam_contact_types - [Countries](https://techdocs.akamai.com/terraform/docs/iam-ds-countries.md): akamai_iam_countries - [Grantable roles](https://techdocs.akamai.com/terraform/docs/iam-ds-grantable-roles.md): akamai_iam_grantable_roles - [Group](https://techdocs.akamai.com/terraform/docs/iam-ds-group.md): akamai_iam_group - [Groups](https://techdocs.akamai.com/terraform/docs/iam-ds-groups.md): akamai_iam_groups - [Password policy](https://techdocs.akamai.com/terraform/docs/iam-ds-password-policy.md): akamai_iam_password_policy - [Property users](https://techdocs.akamai.com/terraform/docs/property-users.md): akamai_iam_property_users - [Role](https://techdocs.akamai.com/terraform/docs/iam-ds-role.md): akamai_iam_role - [Roles](https://techdocs.akamai.com/terraform/docs/iam-ds-roles.md): akamai_iam_roles - [States](https://techdocs.akamai.com/terraform/docs/iam-ds-states.md): akamai_iam_states - [Supported languages](https://techdocs.akamai.com/terraform/docs/iam-ds-supported-languages.md): akamai_iam_supported_langs - [Time zones](https://techdocs.akamai.com/terraform/docs/iam-ds-timezones.md): akamai_iam_timezones - [Timeout policies](https://techdocs.akamai.com/terraform/docs/iam-ds-timeout-policies.md): akamai_iam_timeout_policies - [User](https://techdocs.akamai.com/terraform/docs/iam-ds-user.md): akamai_iam_user - [Users](https://techdocs.akamai.com/terraform/docs/iam-ds-users.md): akamai_iam_users - [Users affected by moving group](https://techdocs.akamai.com/terraform/docs/iam-ds-users-affected-by-moving-group.md): akamai_iam_users_affected_by_moving_group - [API client](https://techdocs.akamai.com/terraform/docs/iam-rc-api-client.md): akamai_iam_api_client - [Blocked user properties](https://techdocs.akamai.com/terraform/docs/iam-rc-blocked-user-properties.md): akamai_iam_blocked_user_properties - [CIDR block](https://techdocs.akamai.com/terraform/docs/iam-rc-cidr-block.md): akamai_iam_cidr_block - [Group](https://techdocs.akamai.com/terraform/docs/iam-rc-group.md): akamai_iam_group - [IP allowlist](https://techdocs.akamai.com/terraform/docs/iam-rc-ip-allowlist.md): akamai_iam_ip_allowlist - [Role](https://techdocs.akamai.com/terraform/docs/iam-rc-role.md): akamai_iam_role - [User](https://techdocs.akamai.com/terraform/docs/iam-rc-user.md): akamai_iam_user - [Provision properties](https://techdocs.akamai.com/terraform/docs/set-up-property-provisioning.md) - [Validate domains](https://techdocs.akamai.com/terraform/docs/validate-domains.md) - [Rules](https://techdocs.akamai.com/terraform/docs/rules.md) - [Includes](https://techdocs.akamai.com/terraform/docs/set-up-includes.md) - [Rule format changes](https://techdocs.akamai.com/terraform/docs/rule-format-changes.md) - [Behaviors and criteria](https://techdocs.akamai.com/terraform/docs/behaviors-criteria.md): v2025-10-16 - [ad_​scaler_​circuit_​breaker](https://techdocs.akamai.com/terraform/docs/ad-scaler-circuit-breaker.md) - [adaptive_​acceleration](https://techdocs.akamai.com/terraform/docs/adaptive-acceleration.md) - [advanced](https://techdocs.akamai.com/terraform/docs/advanced.md) - [aggregated_​reporting](https://techdocs.akamai.com/terraform/docs/aggregated-reporting.md) - [akamaizer](https://techdocs.akamai.com/terraform/docs/akamaizer.md) - [akamaizer_​tag](https://techdocs.akamai.com/terraform/docs/akamaizer-tag.md) - [all_​http_​in_​cache_​hierarchy](https://techdocs.akamai.com/terraform/docs/all-http-in-cache-hierarchy.md) - [allow_​cloudlets_​origins](https://techdocs.akamai.com/terraform/docs/allow-cloudlets-origins.md) - [allow_​delete](https://techdocs.akamai.com/terraform/docs/allow-delete.md) - [allow_​https_​cache_​key_​sharing](https://techdocs.akamai.com/terraform/docs/allow-httpscache-key-sharing.md) - [allow_​https_​downgrade](https://techdocs.akamai.com/terraform/docs/allow-httpsdowngrade.md) - [allow_​options](https://techdocs.akamai.com/terraform/docs/allow-options.md) - [allow_​patch](https://techdocs.akamai.com/terraform/docs/allow-patch.md) - [allow_​post](https://techdocs.akamai.com/terraform/docs/allow-post.md) - [allow_​put](https://techdocs.akamai.com/terraform/docs/allow-put.md) - [allow_​transfer_​encoding](https://techdocs.akamai.com/terraform/docs/allow-transfer-encoding.md) - [alt_​svc_​header](https://techdocs.akamai.com/terraform/docs/alt-svc-header.md) - [api_​prioritization](https://techdocs.akamai.com/terraform/docs/api-prioritization.md) - [application_​load_​balancer](https://techdocs.akamai.com/terraform/docs/application-load-balancer.md) - [audience_​segmentation](https://techdocs.akamai.com/terraform/docs/audience-segmentation.md) - [auto_​domain_​validation](https://techdocs.akamai.com/terraform/docs/auto-domain-validation.md) - [base_​directory](https://techdocs.akamai.com/terraform/docs/base-directory.md) - [boss_​beaconing](https://techdocs.akamai.com/terraform/docs/boss-beaconing.md) - [breadcrumbs](https://techdocs.akamai.com/terraform/docs/breadcrumbs.md) - [break_​connection](https://techdocs.akamai.com/terraform/docs/break-connection.md) - [brotli](https://techdocs.akamai.com/terraform/docs/brotli.md) - [cache_​error](https://techdocs.akamai.com/terraform/docs/cache-error.md) - [cache_​id](https://techdocs.akamai.com/terraform/docs/cache-id.md) - [cache_​key_​ignore_​case](https://techdocs.akamai.com/terraform/docs/cache-key-ignore-case.md) - [cache_​key_​query_​params](https://techdocs.akamai.com/terraform/docs/cache-key-query-params.md) - [cache_​key_​rewrite](https://techdocs.akamai.com/terraform/docs/cache-key-rewrite.md) - [cache_​post](https://techdocs.akamai.com/terraform/docs/cache-post.md) - [cache_​redirect](https://techdocs.akamai.com/terraform/docs/cache-redirect.md) - [cache_​tag](https://techdocs.akamai.com/terraform/docs/cache-tag.md) - [cache_​tag_​visible](https://techdocs.akamai.com/terraform/docs/cache-tag-visible.md) - [caching](https://techdocs.akamai.com/terraform/docs/caching.md) - [central_​authorization](https://techdocs.akamai.com/terraform/docs/central-authorization.md) - [chase_​redirects](https://techdocs.akamai.com/terraform/docs/chase-redirects.md) - [client_​certificate_​auth](https://techdocs.akamai.com/terraform/docs/client-certificate-auth.md) - [client_​characteristics](https://techdocs.akamai.com/terraform/docs/client-characteristics.md) - [cloud_​interconnects](https://techdocs.akamai.com/terraform/docs/cloud-interconnects.md) - [cloud_​wrapper](https://techdocs.akamai.com/terraform/docs/cloud-wrapper.md) - [cloud_​wrapper_​advanced](https://techdocs.akamai.com/terraform/docs/cloud-wrapper-advanced.md) - [common_​media_​client_​data](https://techdocs.akamai.com/terraform/docs/common-media-client-data.md) - [construct_​response](https://techdocs.akamai.com/terraform/docs/construct-response.md) - [content_​characteristics](https://techdocs.akamai.com/terraform/docs/content-characteristics.md) - [content_​characteristics_​amd](https://techdocs.akamai.com/terraform/docs/content-characteristics-amd.md) - [content_​characteristics_​dd](https://techdocs.akamai.com/terraform/docs/content-characteristics-dd.md) - [content_​characteristics_​wsd_​large_​file](https://techdocs.akamai.com/terraform/docs/content-characteristics-wsd-large-file.md) - [content_​characteristics_​wsd_​live](https://techdocs.akamai.com/terraform/docs/content-characteristics-wsd-live.md) - [content_​characteristics_​wsd_​vod](https://techdocs.akamai.com/terraform/docs/content-characteristics-wsd-vod.md) - [content_​targeting_​protection](https://techdocs.akamai.com/terraform/docs/content-targeting-protection.md) - [cors_​support](https://techdocs.akamai.com/terraform/docs/cors-support.md) - [cp_​code](https://techdocs.akamai.com/terraform/docs/cp-code.md) - [custom_​behavior](https://techdocs.akamai.com/terraform/docs/custom-behavior.md) - [datastream](https://techdocs.akamai.com/terraform/docs/datastream.md) - [delivery_​receipt](https://techdocs.akamai.com/terraform/docs/delivery-receipt.md) - [deny_​access](https://techdocs.akamai.com/terraform/docs/deny-access.md) - [deny_​direct_​failover_​access](https://techdocs.akamai.com/terraform/docs/deny-direct-failover-access.md) - [device_​characteristic_​cache_​id](https://techdocs.akamai.com/terraform/docs/device-characteristic-cache-id.md) - [device_​characteristic_​header](https://techdocs.akamai.com/terraform/docs/device-characteristic-header.md) - [dns_​async_​refresh](https://techdocs.akamai.com/terraform/docs/dns-async-refresh.md) - [dns_​prefresh](https://techdocs.akamai.com/terraform/docs/dns-prefresh.md) - [downgrade_​protocol](https://techdocs.akamai.com/terraform/docs/downgrade-protocol.md) - [download_​complete_​marker](https://techdocs.akamai.com/terraform/docs/download-complete-marker.md) - [download_​notification](https://techdocs.akamai.com/terraform/docs/download-notification.md) - [downstream_​cache](https://techdocs.akamai.com/terraform/docs/downstream-cache.md) - [dynamic_​throughtput_​optimization](https://techdocs.akamai.com/terraform/docs/dynamic-throughtput-optimization.md) - [dynamic_​throughtput_​optimization_​override](https://techdocs.akamai.com/terraform/docs/dynamic-throughtput-optimization-override.md) - [dynamic_​web_​content](https://techdocs.akamai.com/terraform/docs/dynamic-web-content.md) - [early_​data](https://techdocs.akamai.com/terraform/docs/early-data.md) - [early_data_advanced](https://techdocs.akamai.com/terraform/docs/early-data-advanced.md) - [early_​hints](https://techdocs.akamai.com/terraform/docs/early-hints.md) - [ecms_​bulk_​upload](https://techdocs.akamai.com/terraform/docs/ecms-bulk-upload.md) - [ecms_​database](https://techdocs.akamai.com/terraform/docs/ecms-database.md) - [ecms_​dataset](https://techdocs.akamai.com/terraform/docs/ecms-dataset.md) - [ecms_​object_​key](https://techdocs.akamai.com/terraform/docs/ecms-object-key.md) - [edge_​connect](https://techdocs.akamai.com/terraform/docs/edge-connect.md) - [edge_​load_​balancing_​advanced](https://techdocs.akamai.com/terraform/docs/edge-load-balancing-advanced.md) - [edge_​load_​balancing_​data_​center](https://techdocs.akamai.com/terraform/docs/edge-load-balancing-data-center.md) - [edge_​load_​balancing_​origin](https://techdocs.akamai.com/terraform/docs/edge-load-balancing-origin.md) - [edge_​origin_​authorization](https://techdocs.akamai.com/terraform/docs/edge-origin-authorization.md) - [edge_​redirector](https://techdocs.akamai.com/terraform/docs/edge-redirector.md) - [edge_​scape](https://techdocs.akamai.com/terraform/docs/edge-scape.md) - [edge_​side_​includes](https://techdocs.akamai.com/terraform/docs/edge-side-includes.md) - [edge_​worker](https://techdocs.akamai.com/terraform/docs/edgeworker.md) - [enforce_​mtls_​settings](https://techdocs.akamai.com/terraform/docs/enforce-mtls-settings.md) - [enhanced_​akamai_​protocol](https://techdocs.akamai.com/terraform/docs/enhanced-akamai-protocol.md) - [enhanced_​debug](https://techdocs.akamai.com/terraform/docs/enhanced-debug.md) - [enhanced_​proxy_​detection](https://techdocs.akamai.com/terraform/docs/enhanced-proxy-detection.md) - [fail_​action](https://techdocs.akamai.com/terraform/docs/fail-action.md) - [failover_​bot_​manager_​feature_​compatibility](https://techdocs.akamai.com/terraform/docs/failover-bot-manager-feature-compatibility.md) - [fips](https://techdocs.akamai.com/terraform/docs/fips.md) - [first_​party_​marketing](https://techdocs.akamai.com/terraform/docs/first-party-marketing.md) - [first_​party_​marketing_​plus](https://techdocs.akamai.com/terraform/docs/first-party-marketing-plus.md) - [forward_​rewrite](https://techdocs.akamai.com/terraform/docs/forward-rewrite.md) - [g_rpc](https://techdocs.akamai.com/terraform/docs/g-rpc.md) - [g2oheader](https://techdocs.akamai.com/terraform/docs/g2oheader.md) - [global_​request_​number](https://techdocs.akamai.com/terraform/docs/global-request-number.md) - [google_tag_gateway](https://techdocs.akamai.com/terraform/docs/google-tag-gateway.md) - [graphql_​caching](https://techdocs.akamai.com/terraform/docs/graphql-caching.md) - [gzip_​response](https://techdocs.akamai.com/terraform/docs/gzip-response.md) - [hd_​data_​advanced](https://techdocs.akamai.com/terraform/docs/hd-data-advanced.md) - [health_​detection](https://techdocs.akamai.com/terraform/docs/health-detection.md) - [hsaf_​eip_​binding](https://techdocs.akamai.com/terraform/docs/hsaf-eip-binding.md) - [http2](https://techdocs.akamai.com/terraform/docs/http2.md) - [http3](https://techdocs.akamai.com/terraform/docs/http3.md) - [http_​strict_​transport_​security](https://techdocs.akamai.com/terraform/docs/http-strict-transport-security.md) - [http_​to_​https_​upgrade](https://techdocs.akamai.com/terraform/docs/http-to-https-upgrade.md) - [im_​override](https://techdocs.akamai.com/terraform/docs/im-override.md) - [image_​manager](https://techdocs.akamai.com/terraform/docs/image-manager.md) - [image_​manager_​video](https://techdocs.akamai.com/terraform/docs/image-manager-video.md) - [instant](https://techdocs.akamai.com/terraform/docs/instant.md) - [instant_​config](https://techdocs.akamai.com/terraform/docs/instant-config.md) - [large_​file_​optimization](https://techdocs.akamai.com/terraform/docs/large-file-optimization.md) - [large_​file_​optimization_​advanced](https://techdocs.akamai.com/terraform/docs/large-file-optimization-advanced.md) - [limit_​bit_​rate](https://techdocs.akamai.com/terraform/docs/limit-bit-rate.md) - [localhost_loopback_protection](https://techdocs.akamai.com/terraform/docs/localhost-loopback-protection.md) - [log_​custom](https://techdocs.akamai.com/terraform/docs/log-custom.md) - [m_​pulse](https://techdocs.akamai.com/terraform/docs/m-pulse.md) - [manifest_​personalization](https://techdocs.akamai.com/terraform/docs/manifest-personalization.md) - [manifest_​rerouting](https://techdocs.akamai.com/terraform/docs/manifest-rerouting.md) - [manual_​server_​push](https://techdocs.akamai.com/terraform/docs/manual-server-push.md) - [media_​acceleration](https://techdocs.akamai.com/terraform/docs/media-acceleration.md) - [media_​acceleration_​quic_​optout](https://techdocs.akamai.com/terraform/docs/media-acceleration-quic-optout.md) - [media_​client](https://techdocs.akamai.com/terraform/docs/media-client.md) - [media_​file_​retrieval_​optimization](https://techdocs.akamai.com/terraform/docs/media-file-retrieval-optimization.md) - [media_​origin_​failover](https://techdocs.akamai.com/terraform/docs/media-origin-failover.md) - [metadata_​caching](https://techdocs.akamai.com/terraform/docs/metadata-caching.md) - [mobile_​sdk_​performance](https://techdocs.akamai.com/terraform/docs/mobile-sdk-performance.md) - [modify_​incoming_​request_​header](https://techdocs.akamai.com/terraform/docs/modify-incoming-request-header.md) - [modify_​incoming_​response_​header](https://techdocs.akamai.com/terraform/docs/modify-incoming-response-header.md) - [modify_​outgoing_​request_​header](https://techdocs.akamai.com/terraform/docs/modify-outgoing-request-header.md) - [modify_​outgoing_​response_​header](https://techdocs.akamai.com/terraform/docs/modify-outgoing-response-header.md) - [modify_​via_​header](https://techdocs.akamai.com/terraform/docs/modify-via-header.md) - [mtls_​origin_​keystore](https://techdocs.akamai.com/terraform/docs/mtls-origin-keystore.md) - [optimize_text_streaming](https://techdocs.akamai.com/terraform/docs/optimize-text-streaming.md) - [origin](https://techdocs.akamai.com/terraform/docs/origin.md) - [origin_​characteristics](https://techdocs.akamai.com/terraform/docs/origin-characteristics.md) - [origin_​characteristics_​wsd](https://techdocs.akamai.com/terraform/docs/origin-characteristics-wsd.md) - [origin_​failure_​recovery_​method](https://techdocs.akamai.com/terraform/docs/origin-failure-recovery-method.md) - [origin_​failure_​recovery_​policy](https://techdocs.akamai.com/terraform/docs/origin-failure-recovery-policy.md) - [origin_​ip_​acl](https://techdocs.akamai.com/terraform/docs/origin-ip-acl.md) - [permissions_​policy](https://techdocs.akamai.com/terraform/docs/permissions-policy.md) - [persistent_​client_​connection](https://techdocs.akamai.com/terraform/docs/persistent-client-connection.md) - [persistent_​connection](https://techdocs.akamai.com/terraform/docs/persistent-connection.md) - [personally_​identifiable_​information](https://techdocs.akamai.com/terraform/docs/personally-identifiable-information.md) - [phased_​release](https://techdocs.akamai.com/terraform/docs/phased-release.md) - [pqc_client_to_edge](https://techdocs.akamai.com/terraform/docs/pqc-client-to-edge.md) - [pqc_origin](https://techdocs.akamai.com/terraform/docs/pqc-origin.md) - [preconnect](https://techdocs.akamai.com/terraform/docs/preconnect.md) - [predictive_​content_​delivery](https://techdocs.akamai.com/terraform/docs/predictive-content-delivery.md) - [predictive_​prefetching](https://techdocs.akamai.com/terraform/docs/predictive-prefetching.md) - [prefetch](https://techdocs.akamai.com/terraform/docs/prefetch.md) - [prefetchable](https://techdocs.akamai.com/terraform/docs/prefetchable.md) - [prefresh_​cache](https://techdocs.akamai.com/terraform/docs/prefresh-cache.md) - [quic_​beta](https://techdocs.akamai.com/terraform/docs/quic-beta.md) - [random_​seek](https://techdocs.akamai.com/terraform/docs/random-seek.md) - [rapid](https://techdocs.akamai.com/terraform/docs/rapid.md) - [read_​timeout](https://techdocs.akamai.com/terraform/docs/read-timeout.md) - [real_​time_​reporting](https://techdocs.akamai.com/terraform/docs/real-time-reporting.md) - [real_​user_​monitoring](https://techdocs.akamai.com/terraform/docs/real-user-monitoring.md) - [redirect](https://techdocs.akamai.com/terraform/docs/redirect.md) - [redirectplus](https://techdocs.akamai.com/terraform/docs/redirectplus.md) - [referer_​checking](https://techdocs.akamai.com/terraform/docs/referer-checking.md) - [remove_​query_​parameter](https://techdocs.akamai.com/terraform/docs/remove-query-parameter.md) - [remove_​vary](https://techdocs.akamai.com/terraform/docs/remove-vary.md) - [report](https://techdocs.akamai.com/terraform/docs/report.md) - [request_​client_​hints](https://techdocs.akamai.com/terraform/docs/request-client-hints.md) - [request_​control](https://techdocs.akamai.com/terraform/docs/request-control.md) - [request_​type_​marker](https://techdocs.akamai.com/terraform/docs/request-type-marker.md) - [resource_​optimizer](https://techdocs.akamai.com/terraform/docs/resource-optimizer.md) - [resource_​optimizer_​extended_​compatibility](https://techdocs.akamai.com/terraform/docs/resource-optimizer-extended-compatibility.md) - [response_​code](https://techdocs.akamai.com/terraform/docs/response-code.md) - [response_​cookie](https://techdocs.akamai.com/terraform/docs/response-cookie.md) - [restrict_​object_​caching](https://techdocs.akamai.com/terraform/docs/restrict-object-caching.md) - [return_​cache_​status](https://techdocs.akamai.com/terraform/docs/return-cache-status.md) - [rewrite_​url](https://techdocs.akamai.com/terraform/docs/rewrite-url.md) - [rum_​custom](https://techdocs.akamai.com/terraform/docs/rum-custom.md) - [saas_​definitions](https://techdocs.akamai.com/terraform/docs/saas-definitions.md) - [sales_​force_​commerce_​cloud_​client](https://techdocs.akamai.com/terraform/docs/sales-force-commerce-cloud-client.md) - [sales_​force_​commerce_​cloud_​provider](https://techdocs.akamai.com/terraform/docs/sales-force-commerce-cloud-provider.md) - [sales_​force_​commerce_​cloud_​provider_​host_​header](https://techdocs.akamai.com/terraform/docs/sales-force-commerce-cloud-provider-host-header.md) - [save_​post_​dca_​processing](https://techdocs.akamai.com/terraform/docs/save-post-dca-processing.md) - [schedule_​invalidation](https://techdocs.akamai.com/terraform/docs/schedule-invalidation.md) - [script_​management](https://techdocs.akamai.com/terraform/docs/script-management.md) - [segmented_​content_​protection](https://techdocs.akamai.com/terraform/docs/segmented-content-protection.md) - [segmented_​media_​optimization](https://techdocs.akamai.com/terraform/docs/segmented-media-optimization.md) - [segmented_​media_​streaming_​prefetch](https://techdocs.akamai.com/terraform/docs/segmented-media-streaming-prefetch.md) - [set_​variable](https://techdocs.akamai.com/terraform/docs/set-variable.md) - [simulate_​error_​code](https://techdocs.akamai.com/terraform/docs/simulate-error-code.md) - [site_​shield](https://techdocs.akamai.com/terraform/docs/site-shield.md) - [standard_​tls_​migration](https://techdocs.akamai.com/terraform/docs/standard-tlsmigration.md) - [standard_​tls_​migration_​override](https://techdocs.akamai.com/terraform/docs/standard-tlsmigration-override.md) - [strict_​header_​parsing](https://techdocs.akamai.com/terraform/docs/strict-header-parsing.md) - [sub_​customer](https://techdocs.akamai.com/terraform/docs/sub-customer.md) - [sure_​route](https://techdocs.akamai.com/terraform/docs/sure-route.md) - [tcp_​optimization](https://techdocs.akamai.com/terraform/docs/tcp-optimization.md) - [tea_​leaf](https://techdocs.akamai.com/terraform/docs/tea-leaf.md) - [tiered_​distribution](https://techdocs.akamai.com/terraform/docs/tiered-distribution.md) - [tiered_​distribution_​advanced](https://techdocs.akamai.com/terraform/docs/tiered-distribution-advanced.md) - [tiered_​distribution_​customization](https://techdocs.akamai.com/terraform/docs/tiered-distribution-customization.md) - [timeout](https://techdocs.akamai.com/terraform/docs/timeout.md) - [uid_​configuration](https://techdocs.akamai.com/terraform/docs/uid-configuration.md) - [validate_​entity_​tag](https://techdocs.akamai.com/terraform/docs/validate-entity-tag.md) - [verify_​json_​web_​token](https://techdocs.akamai.com/terraform/docs/verify-json-web-token.md) - [verify_​token_​authorization](https://techdocs.akamai.com/terraform/docs/verify-token-authorization.md) - [visitor_​prioritization](https://techdocs.akamai.com/terraform/docs/visitor-prioritization.md) - [visitor_prioritization_queue_it](https://techdocs.akamai.com/terraform/docs/visitor-prioritization-queue-it.md) - [watermarking](https://techdocs.akamai.com/terraform/docs/watermarking.md) - [web_​application_​firewall](https://techdocs.akamai.com/terraform/docs/web-application-firewall.md) - [web_​sockets](https://techdocs.akamai.com/terraform/docs/web-sockets.md) - [webdav](https://techdocs.akamai.com/terraform/docs/webdav.md) - [advanced_​im_​match](https://techdocs.akamai.com/terraform/docs/advanced-im-match.md) - [bucket](https://techdocs.akamai.com/terraform/docs/bucket.md) - [cacheability](https://techdocs.akamai.com/terraform/docs/cacheability.md) - [china_​cdn_​region](https://techdocs.akamai.com/terraform/docs/china-cdn-region.md) - [client_​certificate](https://techdocs.akamai.com/terraform/docs/client-certificate.md) - [client_​ip](https://techdocs.akamai.com/terraform/docs/client-ip.md) - [client_​ip_​version](https://techdocs.akamai.com/terraform/docs/client-ip-version.md) - [cloudlets_​origin](https://techdocs.akamai.com/terraform/docs/cloudlets-origin.md) - [content_​delivery_​network](https://techdocs.akamai.com/terraform/docs/content-delivery-network.md) - [content_​type](https://techdocs.akamai.com/terraform/docs/content-type.md) - [debug_​mode](https://techdocs.akamai.com/terraform/docs/debug-mode.md) - [device_​characteristic](https://techdocs.akamai.com/terraform/docs/device-characteristic.md) - [edge_​workers_​failure](https://techdocs.akamai.com/terraform/docs/edge-workers-failure.md) - [file_​extension](https://techdocs.akamai.com/terraform/docs/file-extension.md) - [filename](https://techdocs.akamai.com/terraform/docs/filename.md) - [hostname](https://techdocs.akamai.com/terraform/docs/hostname.md) - [match_​advanced](https://techdocs.akamai.com/terraform/docs/match-advanced.md) - [match_​cp_​code](https://techdocs.akamai.com/terraform/docs/match-cp-code.md) - [match_​response_​code](https://techdocs.akamai.com/terraform/docs/match-response-code.md) - [match_​variable](https://techdocs.akamai.com/terraform/docs/match-variable.md) - [metadata_​stage](https://techdocs.akamai.com/terraform/docs/metadata-stage.md) - [origin_​timeout](https://techdocs.akamai.com/terraform/docs/origin-timeout.md) - [path](https://techdocs.akamai.com/terraform/docs/path.md) - [query_​string_​parameter](https://techdocs.akamai.com/terraform/docs/query-string-parameter.md) - [random](https://techdocs.akamai.com/terraform/docs/random.md) - [recovery_​config](https://techdocs.akamai.com/terraform/docs/recovery-config.md) - [regular_​expression](https://techdocs.akamai.com/terraform/docs/regular-expression.md) - [request_​cookie](https://techdocs.akamai.com/terraform/docs/request-cookie.md) - [request_​header](https://techdocs.akamai.com/terraform/docs/request-header.md) - [request_​method](https://techdocs.akamai.com/terraform/docs/request-method.md) - [request_​protocol](https://techdocs.akamai.com/terraform/docs/request-protocol.md) - [request_​type](https://techdocs.akamai.com/terraform/docs/request-type.md) - [response_​header](https://techdocs.akamai.com/terraform/docs/response-header.md) - [server_​location](https://techdocs.akamai.com/terraform/docs/server-location.md) - [time](https://techdocs.akamai.com/terraform/docs/time.md) - [token_​authorization](https://techdocs.akamai.com/terraform/docs/token-authorization.md) - [user_​agent](https://techdocs.akamai.com/terraform/docs/user-agent.md) - [user_​location](https://techdocs.akamai.com/terraform/docs/user-location.md) - [user_​network](https://techdocs.akamai.com/terraform/docs/user-network.md) - [variable_​error](https://techdocs.akamai.com/terraform/docs/variable-error.md) - [Account hostnames](https://techdocs.akamai.com/terraform/docs/pm-ds-account-hostnames.md): akamai_property_account_hostnames - [CP code](https://techdocs.akamai.com/terraform/docs/pm-ds-cp-code.md): akamai_cp_code - [CP codes](https://techdocs.akamai.com/terraform/docs/pm-ds-cp-codes.md): akamai_cp_codes - [Edge hostname](https://techdocs.akamai.com/terraform/docs/pm-ds-edge-hostname.md): akamai_edge_hostname - [Edge hostnames](https://techdocs.akamai.com/terraform/docs/pm-ds-edge-hostnames.md): akamai_edge_hostnames - [Domain](https://techdocs.akamai.com/terraform/docs/pm-ds-domain.md): akamai_property_domainownership_domain - [Domains](https://techdocs.akamai.com/terraform/docs/pm-ds-domains.md): akamai_property_domainownership_domains - [Hostname activation](https://techdocs.akamai.com/terraform/docs/pm-ds-hostname-activation.md): akamai_property_hostname_activation - [Hostname activations](https://techdocs.akamai.com/terraform/docs/pm-ds-hostname-activations.md): akamai_property_hostname_activations - [Hostname audit history](https://techdocs.akamai.com/terraform/docs/pm-ds-hostname-audit-history.md): akamai_property_hostname_audit_history - [Hostnames](https://techdocs.akamai.com/terraform/docs/pm-ds-hostnames.md): akamai_property_hostnames - [Hostnames diff](https://techdocs.akamai.com/terraform/docs/pm-ds-hostnames-diff.md): akamai_property_hostnames_diff - [Include](https://techdocs.akamai.com/terraform/docs/pm-ds-include.md): akamai_property_include - [Include activation](https://techdocs.akamai.com/terraform/docs/pm-ds-include-activation.md): akamai_property_include_activation - [Include parents](https://techdocs.akamai.com/terraform/docs/pm-ds-include-parents.md): akamai_property_include_parents - [Include rules](https://techdocs.akamai.com/terraform/docs/pm-ds-include-rules.md): akamai_property_include_rules - [Includes](https://techdocs.akamai.com/terraform/docs/pm-ds-includes.md): akamai_property_includes - [Products](https://techdocs.akamai.com/terraform/docs/pm-ds-products.md): akamai_property_products - [Properties](https://techdocs.akamai.com/terraform/docs/pm-ds-properties.md): akamai_properties - [Property](https://techdocs.akamai.com/terraform/docs/pm-ds-property.md): akamai_property - [Property activation](https://techdocs.akamai.com/terraform/docs/pm-ds-property-activation.md): akamai_property_activation - [Search](https://techdocs.akamai.com/terraform/docs/pm-ds-search.md): akamai_properties_search - [Search domains](https://techdocs.akamai.com/terraform/docs/pm-ds-search-domains.md): akamai_property_domainownership_search_domains - [Rule formats](https://techdocs.akamai.com/terraform/docs/pm-ds-rule-formats.md): akamai_property_rule_formats - [Rules](https://techdocs.akamai.com/terraform/docs/pm-ds-property-rules.md): akamai_property_rules - [Rules builder](https://techdocs.akamai.com/terraform/docs/pm-ds-rules-builder.md): akamai_property_rules_builder - [Rules template](https://techdocs.akamai.com/terraform/docs/pm-ds-rules-template.md): akamai_property_rules_template - [Activation](https://techdocs.akamai.com/terraform/docs/pm-rc-activation.md): akamai_property_activation - [CP code](https://techdocs.akamai.com/terraform/docs/pm-rc-cp-code.md): akamai_cp_code - [Domains](https://techdocs.akamai.com/terraform/docs/pm-rc-domains.md): akamai_property_domainownership_domains - [Domain validation](https://techdocs.akamai.com/terraform/docs/pm-rc-domain-validation.md): akamai_property_domainownership_validation - [Edge hostname](https://techdocs.akamai.com/terraform/docs/pm-rc-edge-hostname.md): akamai_edge_hostname - [Hostname bucket](https://techdocs.akamai.com/terraform/docs/pm-rc-hostname-bucket.md): akamai_property_hostname_bucket - [Include](https://techdocs.akamai.com/terraform/docs/pm-rc-include.md): akamai_property_include - [Include activation](https://techdocs.akamai.com/terraform/docs/pm-rc-include-activation.md): akamai_property_include_activation - [Late domain validation](https://techdocs.akamai.com/terraform/docs/pm-rc-domain-late-validation.md): akamai_property_domainownership_late_validation - [Property](https://techdocs.akamai.com/terraform/docs/pm-rc-property.md): akamai_property - [Manage reporting groups](https://techdocs.akamai.com/terraform/docs/manage-reporting-groups.md) - [CP code](https://techdocs.akamai.com/terraform/docs/rg-ds-cp-code.md): akamai_reportinggroups_cp_code - [CP codes](https://techdocs.akamai.com/terraform/docs/rg-ds-cp-codes.md): akamai_reportinggroups_cp_codes - [Reporting group](https://techdocs.akamai.com/terraform/docs/rg-ds-reporting-group.md): akamai_reportinggroups_group - [Reporting groups](https://techdocs.akamai.com/terraform/docs/rg-ds-reporting-groups.md): akamai_reportinggroups_groups - [Reporting group](https://techdocs.akamai.com/terraform/docs/rg-rc-reporting-group.md): akamai_reportinggroups_group - [Configure AppSec](https://techdocs.akamai.com/terraform/docs/configure-appsec.md) - [Match targets](https://techdocs.akamai.com/terraform/docs/match-target-options.md) - [Rate policy](https://techdocs.akamai.com/terraform/docs/rate-policy-options.md) - [Attack group migration](https://techdocs.akamai.com/terraform/docs/attack-group-migration.md) - [AAP selected hostnames](https://techdocs.akamai.com/terraform/docs/as-ds-aap-selected-hostnames.md): akamai_appsec_aap_selected_hostnames - [API endpoints](https://techdocs.akamai.com/terraform/docs/as-ds-api-endpoints.md): akamai_appsec_api_endpoints - [API request constraints](https://techdocs.akamai.com/terraform/docs/as-ds-api-request-constraints.md): akamai_appsec_api_request_constraints - [ASE penalty box settings](https://techdocs.akamai.com/terraform/docs/as-ds-ase-penalty-box-settings.md): akamai_appsec_advanced_settings_ase_penalty_box - [Attack groups](https://techdocs.akamai.com/terraform/docs/as-ds-attack-groups.md): akamai_appsec_attack_groups - [Attack payload logging](https://techdocs.akamai.com/terraform/docs/as-ds-attack-payload-logging.md): akamai_appsec_advanced_settings_attack_payload_logging - [Bypass network lists](https://techdocs.akamai.com/terraform/docs/as-ds-bypass-network-lists.md): akamai_appsec_bypass_network_lists - [Configuration](https://techdocs.akamai.com/terraform/docs/as-ds-configuration.md): akamai_appsec_configuration - [Configuration version](https://techdocs.akamai.com/terraform/docs/as-ds-configuration-version.md): akamai_appsec_configuration_version - [Contracts groups](https://techdocs.akamai.com/terraform/docs/as-ds-contracts-groups.md): akamai_appsec_contracts_groups - [Custom deny](https://techdocs.akamai.com/terraform/docs/as-ds-custom-deny.md): akamai_appsec_custom_deny - [Custom rule actions](https://techdocs.akamai.com/terraform/docs/as-ds-custom-rule-actions.md): akamai_appsec_custom_rule_actions - [Custom rules](https://techdocs.akamai.com/terraform/docs/as-ds-custom-rules.md): akamai_appsec_custom_rules - [Eval group](https://techdocs.akamai.com/terraform/docs/as-ds-eval-group.md): akamai_appsec_eval_group - [Eval penalty box](https://techdocs.akamai.com/terraform/docs/as-ds-eval-penalty.md): akamai_appsec_eval_penalty_box - [Eval penalty box conditions](https://techdocs.akamai.com/terraform/docs/as-ds-eval-penalty-box-conditions.md): akamai_appsec_eval_penalty_box_conditions - [Eval rules](https://techdocs.akamai.com/terraform/docs/as-ds-eval-rules.md): akamai_appsec_eval_rules - [Evasive path match](https://techdocs.akamai.com/terraform/docs/as-ds-evasive-path-match.md): akamai_appsec_advanced_settings_evasive_path_match - [Failover hostnames](https://techdocs.akamai.com/terraform/docs/as-ds-failover-hostnames.md): akamai_appsec_failover_hostnames - [Hostname coverage](https://techdocs.akamai.com/terraform/docs/as-ds-hostname-coverage.md): akamai_appsec_hostname_coverage - [Hostname coverage match targets](https://techdocs.akamai.com/terraform/docs/as-ds-hostname-coverage-match-targets.md): akamai_appsec_hostname_coverage_match_targets - [Hostname coverage overlapping](https://techdocs.akamai.com/terraform/docs/as-ds-hostname-coverage-overlapping.md): akamai_appsec_hostname_coverage_overlapping - [IP geo](https://techdocs.akamai.com/terraform/docs/as-ds-ip-geo.md): akamai_appsec_ip_geo - [JA4 fingerprint](https://techdocs.akamai.com/terraform/docs/as-ds-ja4-fingerprint.md) - [Malware content types](https://techdocs.akamai.com/terraform/docs/as-ds-malware-content-types.md): akamai_appsec_malware_content_types - [Malware policies](https://techdocs.akamai.com/terraform/docs/as-ds-malware-policies.md): akamai_appsec_malware_policies - [Malware policy actions](https://techdocs.akamai.com/terraform/docs/as-ds-malware-policy-actions.md): akamai_appsec_malware_policy_actions - [Match targets](https://techdocs.akamai.com/terraform/docs/as-ds-match-targets.md): akamai_appsec_match_targets - [Penalty box](https://techdocs.akamai.com/terraform/docs/as-ds-peanlty-box.md): akamai_appsec_penalty_box - [Penalty box conditions](https://techdocs.akamai.com/terraform/docs/as-ds-penalty-box-conditions.md): akamai_appsec_penalty_box_conditions - [PII learning](https://techdocs.akamai.com/terraform/docs/as-ds-pii-learning.md): akamai_appsec_advanced_setttings_pii_learning - [Policy actions](https://techdocs.akamai.com/terraform/docs/as-ds-policy-actions.md): akamai_appsec_rate_policy_actions - [Pragma header](https://techdocs.akamai.com/terraform/docs/as-ds-pragma-header.md): akamai_appsec_advanced_settings_pragma_header - [Prefetch](https://techdocs.akamai.com/terraform/docs/as-ds-prefetch.md): akamai_appsec_advanced_settings_prefetch - [Rapid rules](https://techdocs.akamai.com/terraform/docs/as-ds-rapid-rules.md): akamai_appsec_rapid_rules - [Rate policies](https://techdocs.akamai.com/terraform/docs/as-ds-rate-policies.md): akamai_appsec_rate_policies - [Reputation profile actions](https://techdocs.akamai.com/terraform/docs/as-ds-reputation-profile-actions.md): akamai_appsec_reputation_profile_actions - [Reputation profile analysis](https://techdocs.akamai.com/terraform/docs/as-ds-reputation-profile-analysis.md): akamai_appsec_reputation_profile_analysis - [Reputation profiles](https://techdocs.akamai.com/terraform/docs/as-ds-reputation-profiles.md): akamai_appsec_reputation_profiles - [Request body settings](https://techdocs.akamai.com/terraform/docs/as-ds-request-body-settings.md): akamai_appsec_advanced_settings_request_body - [Rule upgrade details](https://techdocs.akamai.com/terraform/docs/as-ds-rule-upgrade-details.md): akamai_appsec_rule_upgrade_details - [Rules](https://techdocs.akamai.com/terraform/docs/as-ds-rules.md): akamai_appsec_rules - [Security policy](https://techdocs.akamai.com/terraform/docs/as-ds-security-policy.md): akamai_appsec_security_policy - [Security policy protections](https://techdocs.akamai.com/terraform/docs/as-ds-security-policy-protections.md): akamai_appsec_security_policy_protections - [Selectable hostnames](https://techdocs.akamai.com/terraform/docs/as-ds-selectable-hostnames.md): akamai_appsec_selectable_hostnames - [Siem definitions](https://techdocs.akamai.com/terraform/docs/as-ds-siem-definitions.md): akamai_appsec_siem_definitions - [Siem settings](https://techdocs.akamai.com/terraform/docs/as-ds-siem-settings.md): akamai_appsec_siem_settings - [Slow POST](https://techdocs.akamai.com/terraform/docs/as-ds-slow-post.md): akamai_appsec_slow_post - [Threat intel](https://techdocs.akamai.com/terraform/docs/as-ds-threat-intel.md): akamai_appsec_threat_intel - [Tuning recommendations](https://techdocs.akamai.com/terraform/docs/as-ds-tuning-recommendations.md): akamai_appsec_tuning_recommendations - [Version notes](https://techdocs.akamai.com/terraform/docs/as-ds-version-notes.md): akamai_appsec_version_notes - [WAF mode](https://techdocs.akamai.com/terraform/docs/as-ds-waf-mode.md): akamai_appsec_waf_mode - [WAF rule set](https://techdocs.akamai.com/terraform/docs/as-ds-waf-rule-set.md): akamai_appsec_waf_ruleset - [URL protection policy](https://techdocs.akamai.com/terraform/docs/as-ds-url-protection-policy.md): akamai_appsec_url_protection_policy - [URL protection policies](https://techdocs.akamai.com/terraform/docs/as-ds-url-protection-policies.md): akamai_appsec_url_protection_policies - [URL protection policy actions](https://techdocs.akamai.com/terraform/docs/as-ds-url-protection-policy-actions.md): akamai_appsec_url_protection_policy_actions - [URL protection policies actions](https://techdocs.akamai.com/terraform/docs/as-ds-url-protection-policies-actions.md): akamai_appsec_url_protection_policies_actions - [AAP selected hostnames](https://techdocs.akamai.com/terraform/docs/as-rc-aap-selected-hostnames.md): akamai_appsec_aap_selected_hostnames - [Activations](https://techdocs.akamai.com/terraform/docs/as-rc-activations.md): akamai_appsec_activations - [Advanced logging](https://techdocs.akamai.com/terraform/docs/as-rc-advanced-logging.md): akamai_appsec_advanced_settings_logging - [API constraints protection](https://techdocs.akamai.com/terraform/docs/as-rc-api-constraints-protection.md): akamai_appsec_api_constraints_protection - [API request constraints](https://techdocs.akamai.com/terraform/docs/as-rc-api-request-constraints.md): appsec_api_request_constraints - [ASE penalty box settings](https://techdocs.akamai.com/terraform/docs/as-rc-ase-penalty-box-settings.md): akamai_appsec_advanced_settings_ase_penalty_box - [Attack group](https://techdocs.akamai.com/terraform/docs/as-rc-attack-group.md): akamai_appsec_attack_group - [Attack payload logging](https://techdocs.akamai.com/terraform/docs/as-rc-attack-payload-logging.md): akamai_appsec_advanced_settings_attack_payload_logging - [Bypass network lists](https://techdocs.akamai.com/terraform/docs/as-rc-bypass-network-lists.md): akamai_appsec_bypass_network_lists - [Configuration](https://techdocs.akamai.com/terraform/docs/as-rc-configuration.md): akamai_appsec_configuration - [Configuration rename](https://techdocs.akamai.com/terraform/docs/as-rc-configuration-rename.md): akamai_appsec_configuration_rename - [Custom deny](https://techdocs.akamai.com/terraform/docs/as-rc-custom-deny.md): akamai_appsec_custom_deny - [Custom rule](https://techdocs.akamai.com/terraform/docs/as-rc-custom-rule.md): akamai_appsec_custom_rule - [Custom rule action](https://techdocs.akamai.com/terraform/docs/as-rc-custom-rule-action.md): akamai_appsec_custom_rule_action - [Eval](https://techdocs.akamai.com/terraform/docs/as-rc-eval.md): akamai_appsec_eval - [Eval group](https://techdocs.akamai.com/terraform/docs/as-rc-eval-group.md): akamai_appsec_eval_group - [Eval penalty box](https://techdocs.akamai.com/terraform/docs/as-rc-eval-penalty-box.md): akamai_appsec_eval_penalty_box - [Eval penalty box conditions](https://techdocs.akamai.com/terraform/docs/as-rc-eval-penalty-box-conditions.md): akamai_appsec_eval_penalty_box_conditions - [Eval rule](https://techdocs.akamai.com/terraform/docs/as-rc-eval-rule.md): akamai_appsec_eval_rule - [Evasive path match](https://techdocs.akamai.com/terraform/docs/as-rc-evasive-path-match.md): akamai_appsec_advanced_settings_evasive_path_match - [IP Geo](https://techdocs.akamai.com/terraform/docs/as-rc-ip-geo.md): akamai_appsec_ip_geo - [IP Geo protection](https://techdocs.akamai.com/terraform/docs/as-rc-ip-geo-protection.md): akamai_appsec_ip_geo_protection - [JA4 fingerprint](https://techdocs.akamai.com/terraform/docs/as-rc-ja4-fingerprint.md): akamai_appsec_advanced_settings_ja4_fingerprint - [Match target sequence](https://techdocs.akamai.com/terraform/docs/as-rc-match-target-sequence.md): akamai_appsec_match_target_sequence - [Malware policy](https://techdocs.akamai.com/terraform/docs/as-rc-malware-policy.md): akamai_appsec_malware_policy - [Malware policy action](https://techdocs.akamai.com/terraform/docs/as-rc-malware-policy-action.md): akamai_appsec_malware_policy_action - [Malware policy actions](https://techdocs.akamai.com/terraform/docs/as-rc-malware-policy-actions.md): akamai_appsec_malware_policy_actions - [Malware protection](https://techdocs.akamai.com/terraform/docs/as-rc-malware-protection.md): akamai_appsec_malware_protection - [Match target](https://techdocs.akamai.com/terraform/docs/as-rc-match-target.md): akamai_appsec_match_target - [Penalty box](https://techdocs.akamai.com/terraform/docs/as-rc-penalty-box.md): akamai_appsec_penalty_box - [Penalty box conditions](https://techdocs.akamai.com/terraform/docs/as-rc-penalty-box-conditions.md): akamai_appsec_penalty_box_conditions - [PII learning](https://techdocs.akamai.com/terraform/docs/as-rc-pii-learning.md): akamai_appsec_advanced_settings_pii_learning - [Policy rename](https://techdocs.akamai.com/terraform/docs/as-rc-policy-rename.md): akamai_appsec_security_policy_rename - [Pragma header](https://techdocs.akamai.com/terraform/docs/as-rc-pragma-header.md): akamai_appsec_advanced_settings_pragma_header - [Prefetch](https://techdocs.akamai.com/terraform/docs/as-rc-prefetch.md): akamai_appsec_advanced_settings_prefetch - [Rapid rules](https://techdocs.akamai.com/terraform/docs/as-rc-rapid-rules.md): akamai_appsec_rapid_rules - [Rate policy](https://techdocs.akamai.com/terraform/docs/as-rc-rate-policy.md): akamai_appsec_rate_policy - [Rate policy action](https://techdocs.akamai.com/terraform/docs/as-rc-rate-policy-action.md): akamai_appsec_rate_policy_action - [Rate protection](https://techdocs.akamai.com/terraform/docs/as-rc-rate-protection.md): akamai_appsec_rate_protection - [Reputation profile](https://techdocs.akamai.com/terraform/docs/as-rc-reputation-profile.md): akamai_appsec_reputation_profile - [Reputation profile action](https://techdocs.akamai.com/terraform/docs/as-rc-reputation-profile-action.md): akamai_appsec_reputation_profile_action - [Reputation profile analysis](https://techdocs.akamai.com/terraform/docs/as-rc-reputation-analysis.md): akamai_appsec_reputation_analysis - [Reputation protection](https://techdocs.akamai.com/terraform/docs/as-rc-reputation-protection.md): akamai_appsec_reputation_protection - [Request body settings](https://techdocs.akamai.com/terraform/docs/request-body-settings.md): akamai_appsec_advanced_settings_request_body - [Rule](https://techdocs.akamai.com/terraform/docs/as-rc-rule.md): akamai_appsec_rule - [Rule upgrade](https://techdocs.akamai.com/terraform/docs/as-rc-rule-upgrade.md): akamai_appsec_rule_upgrade - [Security policy](https://techdocs.akamai.com/terraform/docs/as-rc-security-policy.md): akamai_appsec_security_policy - [Security policy default protections](https://techdocs.akamai.com/terraform/docs/as-rc-security-policy-default-protections.md): akamai_appsec_security_policy_default_protections - [Security policy protections](https://techdocs.akamai.com/terraform/docs/as-rc-security-policy-protections.md): akamai_appsec_security_policy_protections - [SIEM settings](https://techdocs.akamai.com/terraform/docs/as-rc-siem-settings.md): akamai_appsec_siem_settings - [Slow POST](https://techdocs.akamai.com/terraform/docs/as-rc-slow-post.md): akamai_appsec_slow_post - [Slow POST protection](https://techdocs.akamai.com/terraform/docs/as-rc-slow-post-protection.md): akamai_appsec_slowpost_protection - [Threat intel](https://techdocs.akamai.com/terraform/docs/as-rc-threat-intel.md): akamai_appsec_threat_intel - [Version notes](https://techdocs.akamai.com/terraform/docs/as-rc-version-notes.md): akamai_appsec_version_notes - [WAF mode](https://techdocs.akamai.com/terraform/docs/as-rc-waf-mode.md): akamai_appsec_waf_mode - [WAF protections](https://techdocs.akamai.com/terraform/docs/as-rc-waf-protections.md): akamai_appsec_waf_protection - [WAF rule set](https://techdocs.akamai.com/terraform/docs/as-rc-waf-rule-set.md): akamai_appsec_waf_ruleset - [URL protection action](https://techdocs.akamai.com/terraform/docs/as-rc-url-protection-action.md): akamai_appsec_url_protection_action - [URL protection policy](https://techdocs.akamai.com/terraform/docs/as-rc-url-protection-policy.md): akamai_appsec_url_protection_policy - [Register an API](https://techdocs.akamai.com/terraform/docs/set-up-apidefinitions.md) - [OpenAPI](https://techdocs.akamai.com/terraform/docs/apidef-ds-openapi.md) - [API](https://techdocs.akamai.com/terraform/docs/apidef-ds-api.md) - [Resource operations](https://techdocs.akamai.com/terraform/docs/apidef-ds-resource-operations.md) - [Activation](https://techdocs.akamai.com/terraform/docs/apidef-rc-activation.md) - [API](https://techdocs.akamai.com/terraform/docs/apidef-rc-api.md) - [Resource operations](https://techdocs.akamai.com/terraform/docs/apidef-rc-resource-operations.md) - [Define bot responses](https://techdocs.akamai.com/terraform/docs/set-up-botman.md) - [Protect your webpages from scrapers](https://techdocs.akamai.com/terraform/docs/protect-your-webpages-from-scrapers.md) - [Bot category](https://techdocs.akamai.com/terraform/docs/bmgr-ds-bot-category.md): akamai_botman_akamai_bot_category - [Bot category action](https://techdocs.akamai.com/terraform/docs/bmgr-ds-bot-category-action.md): akamai_botman_akamai_bot_category_action - [Bot category exception](https://techdocs.akamai.com/terraform/docs/bmgr-ds-bot-category-exception.md): akamai_botman_bot_category_exception - [Bot endpoint coverage report](https://techdocs.akamai.com/terraform/docs/bmgr-ds-bot-endpoint-coverage-report.md): akamai_botman_bot_endpoint_coverage_report - [Bot management settings](https://techdocs.akamai.com/terraform/docs/bmgr-ds-bot-management-settings.md): akamai_botman_bot_management_settings - [Bot sequence](https://techdocs.akamai.com/terraform/docs/bmgr-ds-custom-bot-category-item-sequence.md): akamai_botman_custom_bot_category_item_sequence - [Challenge action](https://techdocs.akamai.com/terraform/docs/bmgr-ds-challenge-action.md): akamai_botman_challenge_action - [Challenge injection rules](https://techdocs.akamai.com/terraform/docs/bmgr-ds-challenge-injection-rules.md): akamai_botman_challenge_injection_rules - [Client-side security](https://techdocs.akamai.com/terraform/docs/bmgr-ds-client-side-security.md): akamai_botman_client_side_security - [Conditional action](https://techdocs.akamai.com/terraform/docs/bmgr-ds-conditional-action.md): akamai_botman_conditional_action - [Content protection JavaScript injection rule](https://techdocs.akamai.com/terraform/docs/cpr-ds-javascript-injection-rule.md): akamai_botman_content_protection_javascript_injection_rule - [Content protection rule](https://techdocs.akamai.com/terraform/docs/cpr-ds-rule.md): akamai_botman_content_protection_rule - [Content protection rule sequence](https://techdocs.akamai.com/terraform/docs/cpr-ds-rule-sequence.md): akamai_botman_content_protection_rule_sequence - [Custom-bot category](https://techdocs.akamai.com/terraform/docs/bmgr-ds-custom-bot-category.md): akamai_botman_custom_bot_category - [Custom-bot category action](https://techdocs.akamai.com/terraform/docs/bmgr-ds-custom-bot-category-action.md): akamai_botman_custom_bot_category_action - [Custom-bot category sequence](https://techdocs.akamai.com/terraform/docs/bmgr-ds-custom-bot-category-sequence.md): akamai_botman_custom_bot_category_sequence - [Custom-defined bot](https://techdocs.akamai.com/terraform/docs/bmgr-ds-custom-defined-bot.md): akamai_botman_custom_defined_bot - [Custom client](https://techdocs.akamai.com/terraform/docs/bmgr-ds-custom-client.md): akamai_botman_custom_client - [Custom client sequence](https://techdocs.akamai.com/terraform/docs/bmgr-ds-custom-client-sequence.md): akamai_botman_custom_client_sequence - [Custom deny action](https://techdocs.akamai.com/terraform/docs/bmgr-ds-custom-deny-action.md): akamai_botman_custom_deny_action - [Defined bot](https://techdocs.akamai.com/terraform/docs/bmgr-ds-defined-bot.md): akamai_botman_akamai_defined_bo - [Detection](https://techdocs.akamai.com/terraform/docs/bmgr-ds-detection.md): akamai_botman_bot_detection - [Detection action](https://techdocs.akamai.com/terraform/docs/dbmgr-ds-etection-action.md): akamai_botman_bot_detection_action - [JavaScript injection](https://techdocs.akamai.com/terraform/docs/bmgr-ds-javascript-injection.md): akamai_botman_javascript_injection - [Recategorized Akamai-defined bot](https://techdocs.akamai.com/terraform/docs/bmgr-ds-recategorized-akamai-defined-bot.md): akamai_botman_recategorized_akamai_defined_bot - [Response action](https://techdocs.akamai.com/terraform/docs/bmgr-ds-response-action.md): akamai_botman_response_action - [Serve alternate action](https://techdocs.akamai.com/terraform/docs/bmgr-ds-alternative-action.md): akamai_botman_serve_alternate_action - [Transactional endpoint](https://techdocs.akamai.com/terraform/docs/bmgr-ds-transactional-endpoint.md): akamai_botman_transactional_endpoint - [Transactional endpoint protection](https://techdocs.akamai.com/terraform/docs/bmgr-ds-transactional-endpoint-protection.md): akamai_botman_transactional_endpoint_protection - [Bot detection action](https://techdocs.akamai.com/terraform/docs/bmgr-rc-bot-detection-action.md): akamai_botman_bot_detection_action - [Bot category action](https://techdocs.akamai.com/terraform/docs/bmgr-rc-bot-category-action.md): akamai_botman_akamai_bot_category_action - [Bot category exception](https://techdocs.akamai.com/terraform/docs/bmgr-rc-bot-category-exception.md): akamai_botman_bot_category_exception - [Bot management settings](https://techdocs.akamai.com/terraform/docs/bmgr-rc-bot-management-settings.md): akamai_botman_bot_management_settings - [Bot sequence](https://techdocs.akamai.com/terraform/docs/bmgr-rc-custom-bot-category-item-sequence.md): akamai_botman_custom_bot_category_item_sequence - [Challenge action](https://techdocs.akamai.com/terraform/docs/bmgr-rc-challenge-action.md): akamai_botman_challenge_action - [Challenge injection rules](https://techdocs.akamai.com/terraform/docs/bmgr-rc-challenge-injection-rules.md): akamai_botman_challenge_injection_rules - [Conditional action](https://techdocs.akamai.com/terraform/docs/bmgr-rc-conditional-action.md): akamai_botman_conditional_action - [Content protection JavaScript injection rule](https://techdocs.akamai.com/terraform/docs/cpr-rc-javascript-injection-rule.md): akamai_botman_content_protection_javascript_injection_rule - [Content protection rule](https://techdocs.akamai.com/terraform/docs/cpr-rc-rule.md): akamai_botman_content_protection_rule - [Content protection rule sequence](https://techdocs.akamai.com/terraform/docs/cpr-rc-rule-sequence.md): akamai_botman_content_protection_rule_sequence - [Client-side security](https://techdocs.akamai.com/terraform/docs/bmgr-rc-client-side-security.md): akamai_botman_client_side_security - [Custom-bot category](https://techdocs.akamai.com/terraform/docs/bmgr-rc-custom-bot-category.md): akamai_botman_custom_bot_category - [Custom-bot category action](https://techdocs.akamai.com/terraform/docs/bmgr-rc-custom-bot-category-action.md): akamai_botman_custom_bot_category_action - [Custom-bot category sequence](https://techdocs.akamai.com/terraform/docs/bmgr-rc-custom-bot-category-sequence.md): akamai_botman_custom_bot_category_sequence - [Custom client](https://techdocs.akamai.com/terraform/docs/bmgr-rc-custom-client.md): akamai_botman_custom_client - [Custom client sequence](https://techdocs.akamai.com/terraform/docs/bmgr-rc-custom-client-sequence.md): akamai_botman_custom_client_sequence - [Custom-defined bot](https://techdocs.akamai.com/terraform/docs/bmgr-rc-custom-defined-bot.md): akamai_botman_custom_defined_bot - [Custom deny action](https://techdocs.akamai.com/terraform/docs/bmgr-rc-custom-deny-action.md): akamai_botman_custom_deny_action - [JavaScript injection](https://techdocs.akamai.com/terraform/docs/bmgr-rc-javascript-injection.md): akamai_botman_javascript_injection - [Recategorized Akamai-defined bot](https://techdocs.akamai.com/terraform/docs/bmgr-rc-recategorized-akamai-defined-bot.md): akamai_botman_recategorized_akamai_defined_bot - [Serve alternate action](https://techdocs.akamai.com/terraform/docs/bmgr-rc-serve-alternate-action.md): akamai_botman_serve_alternate_action - [Transactional endpoint](https://techdocs.akamai.com/terraform/docs/bmgr-rc-transactional-endpoint.md): akamai_botman_transactional_endpoint - [Transactional endpoint protection](https://techdocs.akamai.com/terraform/docs/bmgr-rc-transactional-endpoint-protection.md): akamai_botman_transactional_endpoint_protection - [Configure client lists](https://techdocs.akamai.com/terraform/docs/set-up-client-lists.md) - [Client list](https://techdocs.akamai.com/terraform/docs/cl-ds-client-list.md): akamai_clientlist_list - [Client lists](https://techdocs.akamai.com/terraform/docs/cl-ds-client-lists.md): akamai_clientlist_lists - [Client list](https://techdocs.akamai.com/terraform/docs/cl-rc-client-list.md): akamai_clientlist_list - [Activation](https://techdocs.akamai.com/terraform/docs/cl-rc-activation.md): akamai_clientlist_activation - [Configure network lists](https://techdocs.akamai.com/terraform/docs/set-up-network-lists.md) - [Network lists](https://techdocs.akamai.com/terraform/docs/nl-ds-network-lists.md): akamai_networklist_network_lists - [Activations](https://techdocs.akamai.com/terraform/docs/nl-rc-activations.md): akamai_networklist_activations - [Description](https://techdocs.akamai.com/terraform/docs/nl-rc-description.md): akamai_networklist_description - [Network List](https://techdocs.akamai.com/terraform/docs/nl-rc-network-list.md): akamai_networklist_network_list - [Subscription](https://techdocs.akamai.com/terraform/docs/nl-rc-subscription.md): akamai_networklist_subscription - [Manage user behavior](https://techdocs.akamai.com/terraform/docs/set-up-apr.md) - [General settings](https://techdocs.akamai.com/terraform/docs/apr-ds-general-settings.md): akamai_apr_general_settings - [Protected operations](https://techdocs.akamai.com/terraform/docs/apr-ds-protected-operations.md): akamai_apr_protected_operations - [User allow list](https://techdocs.akamai.com/terraform/docs/apr-ds-user-allow-list.md): akamai_apr_user_allow_list - [User risk response strategy](https://techdocs.akamai.com/terraform/docs/apr-ds-user-risk-response-strategy.md): akamai_apr_user_risk_response_strategy - [General settings](https://techdocs.akamai.com/terraform/docs/apr-rc-general-settings.md): akamai_apr_general_settings - [Protected operations](https://techdocs.akamai.com/terraform/docs/apr-rc-protected-operations.md): akamai_apr_protected_operations - [User allow list](https://techdocs.akamai.com/terraform/docs/apr-rc-user-allow-list.md): akamai_apr_user_allow_lis - [User risk response strategy](https://techdocs.akamai.com/terraform/docs/apr-rc-user-risk-response-strategy.md): akamai_apr_user_risk_response_strategy - [Configure DNS zones](https://techdocs.akamai.com/terraform/docs/set-up-edgedns.md) - [Authorities set](https://techdocs.akamai.com/terraform/docs/dns-authorities.md): akamai_authorities_set - [DNS record set](https://techdocs.akamai.com/terraform/docs/dns-record-set.md): akamai_dns_record_set - [DNSSEC record status](https://techdocs.akamai.com/terraform/docs/dns-dnssec-status.md): akamai_zone_dnssec_status - [DNS record](https://techdocs.akamai.com/terraform/docs/dns-record.md): akamai_dns_record - [DNS zone](https://techdocs.akamai.com/terraform/docs/dns-zone.md): akamai_dns_zone - [Provision certificates](https://techdocs.akamai.com/terraform/docs/cps-integration-guide.md) - [Certificate Signing Request](https://techdocs.akamai.com/terraform/docs/cps-ds-certificate-signing-request.md): akamai_cps_csr - [Deployments](https://techdocs.akamai.com/terraform/docs/cps-ds-deployments.md): akamai_cps_deployments - [Enrollment](https://techdocs.akamai.com/terraform/docs/cps-ds-enrollment.md): akamai_cps_enrollment - [Enrollments](https://techdocs.akamai.com/terraform/docs/cps-ds-enrollments.md): akamai_cps_enrollments - [Warnings](https://techdocs.akamai.com/terraform/docs/cps-ds-warnings.md): akamai_cps_warnings - [3rd-party enrollment](https://techdocs.akamai.com/terraform/docs/cps-rc-3rd-party-enrollment.md): akamai_cps_third_party_enrollment - [DV enrollment](https://techdocs.akamai.com/terraform/docs/cps-rc-dv-enrollment.md): akamai_cps_dv_enrollment - [DV validation](https://techdocs.akamai.com/terraform/docs/cps-rc-dv-validation.md): akamai_cps_dv_validation - [Upload certificate](https://techdocs.akamai.com/terraform/docs/cps-rc-upload-certificate.md): akamai_cps_upload_certificate - [Add and maintain policy rules](https://techdocs.akamai.com/terraform/docs/set-up-ivm.md) - [Transform images](https://techdocs.akamai.com/terraform/docs/transform-images.md) - [Policy image](https://techdocs.akamai.com/terraform/docs/ivm-ds-policy-image.md): akamai_imaging_policy_image - [Policy video](https://techdocs.akamai.com/terraform/docs/ivm-ds-policy-video.md): akamai_imaging_policy_video - [Policy image](https://techdocs.akamai.com/terraform/docs/ivm-rc-policy-image.md): akamai_imaging_policy_image - [Policy set](https://techdocs.akamai.com/terraform/docs/ivm-rc-policy-set.md): akamai_imaging_policy_set - [Policy video](https://techdocs.akamai.com/terraform/docs/ivm-rc-policy-video.md): akamai_imaging_policy_video - [Create domain configurations](https://techdocs.akamai.com/terraform/docs/set-up-gtm.md) - [AS map](https://techdocs.akamai.com/terraform/docs/gtm-ds-asmap.md): akamai_gtm_asmap - [CIDR map](https://techdocs.akamai.com/terraform/docs/gtm-ds-cidr-map.md): akamai_gtm_cidrmap - [Default datacenter](https://techdocs.akamai.com/terraform/docs/gtm-ds-default-datacenter.md): akamai_gtm_default_datacenter - [Datacenter](https://techdocs.akamai.com/terraform/docs/datacenter.md): akamai_gtm_datacenter - [Datacenters](https://techdocs.akamai.com/terraform/docs/datacenters.md): akamai_gtm_datacenters - [Domain](https://techdocs.akamai.com/terraform/docs/gtm-ds-domain.md) - [Domains](https://techdocs.akamai.com/terraform/docs/gtm-ds-domains.md): akamai_gtm_domains - [Geo map](https://techdocs.akamai.com/terraform/docs/gtm-ds-geomap.md): akamai_gtm_geomap - [Geo maps](https://techdocs.akamai.com/terraform/docs/gtm-ds-geomaps.md): akamai_gtm_geomaps - [Resource](https://techdocs.akamai.com/terraform/docs/gtm-ds-resource.md): akamai_gtm_resource - [Resources](https://techdocs.akamai.com/terraform/docs/gtm-ds-resources.md): akamai_gtm_resources - [AS map](https://techdocs.akamai.com/terraform/docs/gtm-rc-asmap.md): akamai_gtm_asmap - [CIDR map](https://techdocs.akamai.com/terraform/docs/gtm-rc-cidrmap.md): akamai_gtm_cidrmap - [Datacenter](https://techdocs.akamai.com/terraform/docs/gtm-rc-datacenter.md): akamai_gtm_datacenter - [Domain](https://techdocs.akamai.com/terraform/docs/gtm-rc-domain.md): akamai_gtm_domain - [Geo map](https://techdocs.akamai.com/terraform/docs/gtm-rc-geomap.md): akamai_gtm_geomap - [Property](https://techdocs.akamai.com/terraform/docs/gtm-rc-property.md): akamai_gtm_property - [Resource](https://techdocs.akamai.com/terraform/docs/gtm-rc-resource.md): akamai_gtm_resource - [Add custom cache layer](https://techdocs.akamai.com/terraform/docs/set-up-cloud-wrapper.md) - [Capacities](https://techdocs.akamai.com/terraform/docs/cw-ds-capacities.md): akamai_cloudwrapper_capacities - [Configuration](https://techdocs.akamai.com/terraform/docs/cw-ds-configuration.md): akamai_cloudwrapper_configuration - [Configurations](https://techdocs.akamai.com/terraform/docs/cw-ds-configurations.md): akamai_cloudwrapper_configurations - [Location](https://techdocs.akamai.com/terraform/docs/cw-ds-location.md): akamai_cloudwrapper_location - [Locations](https://techdocs.akamai.com/terraform/docs/cw-ds-locations.md): akamai_cloudwrapper_locations - [Properties](https://techdocs.akamai.com/terraform/docs/cw-ds-properties.md): akamai_cloudwrapper_properties - [Configuration](https://techdocs.akamai.com/terraform/docs/cw-rc-configuration.md): akamai_cloudwrapper_configuration - [Activation](https://techdocs.akamai.com/terraform/docs/cw-rc-activation.md): akamai_cloudwrapper_activation - [Set up Cloudlets policies](https://techdocs.akamai.com/terraform/docs/set-up-cloudlets.md): Create, configure, and activate Cloudlets - [API prioritization match rule](https://techdocs.akamai.com/terraform/docs/cl-ds-api-prioritization-match-rule.md): akamai_cloudlets_api_prioritization_match_rule - [Application load balancer](https://techdocs.akamai.com/terraform/docs/cl-ds-application-load-balancer.md): akamai_cloudlets_application_load_balancer - [Audience segmentation match rule](https://techdocs.akamai.com/terraform/docs/cl-ds-audience-segmentation-match-rule.md): akamai_cloudlets_audience_segmentation_match_rule - [Edge redirector match rule](https://techdocs.akamai.com/terraform/docs/cl-ds-edge-redirector-match-rule.md): akamai_cloudlets_edge_redirector_match_rule - [Forward rewrite match rule](https://techdocs.akamai.com/terraform/docs/cl-ds-forward-rewrite-match-rule.md): akamai_cloudlets_forward_rewrite_match_rule - [Load balancer match rule](https://techdocs.akamai.com/terraform/docs/cl-ds-load-balancer-match-rule.md): akamai_cloudlets_application_load_balancer_match_rule - [Phased release match rule](https://techdocs.akamai.com/terraform/docs/cl-ds-phased-release-match-rule.md): akamai_cloudlets_phased_release_match_rule - [Policy](https://techdocs.akamai.com/terraform/docs/cl-ds-policy.md): akamai_cloudlets_policy - [Policy activation](https://techdocs.akamai.com/terraform/docs/cl-ds-policy-activation.md): akamai_cloudlets_policy_activation - [Request control match rule](https://techdocs.akamai.com/terraform/docs/cl-ds-request-control-match-rule.md): akamai_cloudlets_request_control_match_rule - [Shared policy](https://techdocs.akamai.com/terraform/docs/cl-ds-shared-policy.md): akamai_cloudlets_shared_policy - [Visitor prioritization match rule](https://techdocs.akamai.com/terraform/docs/cl-ds-visitor-prioritization-match-rule.md): akamai_cloudlets_visitor_prioritization_match_rule - [Application load balancer](https://techdocs.akamai.com/terraform/docs/cs-rc-app-load-balancer.md): akamai_cloudlets_application_load_balancer - [Application load balancer activation](https://techdocs.akamai.com/terraform/docs/cs-rc-application-load-balancer-activation.md): akamai_cloudlets_application_load_balancer_activation - [Policy activation](https://techdocs.akamai.com/terraform/docs/cs-rc-policy-activation.md): akamai_cloudlets_policy_activation - [Policy](https://techdocs.akamai.com/terraform/docs/cs-rc-policy.md): akamai_cloudlets_policy - [Enable EdgeWorkers functions](https://techdocs.akamai.com/terraform/docs/set-up-edgeworkers.md) - [Activation](https://techdocs.akamai.com/terraform/docs/ew-ds-activation.md): akamai_edgeworker_activation - [EdgeWorker](https://techdocs.akamai.com/terraform/docs/ew-ds-edgeworker.md): akamai_edgeworker - [EdgeKV group items](https://techdocs.akamai.com/terraform/docs/edgekv-group-items.md): akamai_edgekv_group_items - [EdgeKV groups](https://techdocs.akamai.com/terraform/docs/edgekv-ds-groups.md): akamai_edgekv_groups - [Property rules](https://techdocs.akamai.com/terraform/docs/ew-ds-property-rules.md): akamai_edgeworkers_property_rules - [Resource tier](https://techdocs.akamai.com/terraform/docs/ew-ds-resource-tier.md): akamai_edgeworkers_resource_tier - [Activation](https://techdocs.akamai.com/terraform/docs/ew-rc-activation.md): akamai_edgeworkers_activation - [EdgeKV](https://techdocs.akamai.com/terraform/docs/ew-rc-edgekv.md): akamai_edgekv - [EdgeKV group items](https://techdocs.akamai.com/terraform/docs/edgekv-rc-group-items.md): akamai_edgekv_group_items - [EdgeWorkers](https://techdocs.akamai.com/terraform/docs/ew-rc-edgeworkers.md): akamai_edgeworker - [Create data streams](https://techdocs.akamai.com/terraform/docs/set-up-datastream.md) - [DataStream migration](https://techdocs.akamai.com/terraform/docs/datastream-migration.md) - [Activation history](https://techdocs.akamai.com/terraform/docs/ds-activation-history.md): akamai_datastream_activation_history - [AppSec configurations](https://techdocs.akamai.com/terraform/docs/ds-ds-appsec-configurations.md): akamai_datastream_appsec_configs - [Data set fields](https://techdocs.akamai.com/terraform/docs/ds-dataset-fields.md): akamai_datastream_dataset_fields - [Data streams](https://techdocs.akamai.com/terraform/docs/ds-datastreams.md): akamai_datastreams - [Data stream](https://techdocs.akamai.com/terraform/docs/rc-datastream.md): akamai_datastream - [Manage cloud origin access](https://techdocs.akamai.com/terraform/docs/set-up-cam.md): Cloud Access Manager - [Access key](https://techdocs.akamai.com/terraform/docs/cam-ds-access-key.md): akamai_cloudaccess_key - [Access keys](https://techdocs.akamai.com/terraform/docs/cam-ds-access-keys.md): akamai_cloudaccess_keys - [Access key versions](https://techdocs.akamai.com/terraform/docs/ds-cam-ak-versions.md): akamai_cloudaccess_key_versions - [Access key properties](https://techdocs.akamai.com/terraform/docs/ds-cam-ak-properties.md): akamai_cloudaccess_key_properties - [Access key](https://techdocs.akamai.com/terraform/docs/cam-rc-access-key.md): akamai_cloudaccess_key - [Manage client certificates](https://techdocs.akamai.com/terraform/docs/manage-client-certificates.md) - [Account CA certificates](https://techdocs.akamai.com/terraform/docs/moks-ds-account-ca-certificates.md): akamai_mtlskeystore_account_ca_certificates - [Client certificate](https://techdocs.akamai.com/terraform/docs/moks-ds-client-certificate.md): akamai_mtlskeystore_client_certificate - [Client certificates](https://techdocs.akamai.com/terraform/docs/moks-ds-client-certificates.md): akamai_mtlskeystore_client_certificates - [Akamai client certificate](https://techdocs.akamai.com/terraform/docs/moks-rc-akamai-client-certificate.md): akamai_mtlskeystore_client_certificate_akamai - [Third-party client certificate](https://techdocs.akamai.com/terraform/docs/moks-rc-third-party-client-certificate.md): akamai_mtlskeystore_client_certificate_third_party - [Upload client certificate](https://techdocs.akamai.com/terraform/docs/moks-rc-upload-client-certificate.md): akamai_mtlskeystore_client_certificate_upload - [Manage certificate authority sets](https://techdocs.akamai.com/terraform/docs/manage-ca-sets.md) - [CA set](https://techdocs.akamai.com/terraform/docs/mets-ds-ca-set.md): akamai_mtlstruststore_ca_set - [CA sets](https://techdocs.akamai.com/terraform/docs/mets-ds-ca-sets.md): akamai_mtlstruststore_ca_sets - [CA set activation](https://techdocs.akamai.com/terraform/docs/mets-ds-ca-set-activation.md): akamai_mtlstruststore_ca_set_activation - [CA set activations](https://techdocs.akamai.com/terraform/docs/mets-ds-ca-set-activations.md): akamai_mtlstruststore_ca_set_activations - [CA set activities](https://techdocs.akamai.com/terraform/docs/mets-ds-ca-set-activities.md): akamai_mtlstruststore_ca_set_activities - [CA set associations](https://techdocs.akamai.com/terraform/docs/mets-ds-ca-set-associations.md): akamai_mtlstruststore_ca_set_associations - [CA set certificates](https://techdocs.akamai.com/terraform/docs/mets-ds-ca-set-certificates.md): akamai_mtlstruststore_ca_set_certificates - [CA set versions](https://techdocs.akamai.com/terraform/docs/mets-ds-ca-set-versions.md): akamai_mtlstruststore_ca_set_versions - [CA set](https://techdocs.akamai.com/terraform/docs/mets-rc-ca-set.md): akamai_mtlstruststore_ca_set - [CA set activation](https://techdocs.akamai.com/terraform/docs/mets-rc-ca-set-activation.md): akamai_mtlstruststore_ca_set_activation - [Outdated versions](https://techdocs.akamai.com/terraform/docs/outdated-versions.md) # Test Center Documentation > Akamai's Test Center is a testing tool that checks the effect of configuration changes on your web property. Use this tool as part of your testing protocol to increase your confidence in the safety and accuracy of your configuration changes. ## Guides - [Welcome to Test Center](https://techdocs.akamai.com/test-ctr/docs/welcome-test-center.md) - [Get started](https://techdocs.akamai.com/test-ctr/docs/get-started.md) - [Key terms and concepts](https://techdocs.akamai.com/test-ctr/docs/glossary.md) - [Create and manage functional objects](https://techdocs.akamai.com/test-ctr/docs/functional-objects.md) - [Run a functional test](https://techdocs.akamai.com/test-ctr/docs/functional-test.md) - [Create and manage comparative objects](https://techdocs.akamai.com/test-ctr/docs/comparative-testing.md) - [Run a comparative test](https://techdocs.akamai.com/test-ctr/docs/comparative-test.md) - [Run both tests](https://techdocs.akamai.com/test-ctr/docs/run-both-tests.md) - [Run tests from Property Manager](https://techdocs.akamai.com/test-ctr/docs/functional-comparative-property-manager.md) - [Test run results](https://techdocs.akamai.com/test-ctr/docs/test-run-results.md) ## API Reference - [Test Center API v3](https://techdocs.akamai.com/test-ctr/reference/api.md) - [API summary](https://techdocs.akamai.com/test-ctr/reference/api-summary.md) - [Get started](https://techdocs.akamai.com/test-ctr/reference/api-get-started.md) - [Test Center concepts](https://techdocs.akamai.com/test-ctr/reference/test-center-concepts.md) - [API workflow](https://techdocs.akamai.com/test-ctr/reference/api-workflow.md) - [Work on test suite and child objects simultaneously](https://techdocs.akamai.com/test-ctr/reference/work-on-test-suite-and-child-objects-simultaneously.md) - [Use Test Center with granular operations](https://techdocs.akamai.com/test-ctr/reference/use-test-center-with-granular-operations.md) - [Run a functional test](https://techdocs.akamai.com/test-ctr/reference/run-a-functional-test.md) - [Example: create a condition](https://techdocs.akamai.com/test-ctr/reference/example-create-condition.md) - [Resource limiting](https://techdocs.akamai.com/test-ctr/reference/resource-limiting.md) - [Variables](https://techdocs.akamai.com/test-ctr/reference/variables-overview.md) - [Partial success responses](https://techdocs.akamai.com/test-ctr/reference/partial-success-responses.md) - [Errors](https://techdocs.akamai.com/test-ctr/reference/api-errors.md) - [400](https://techdocs.akamai.com/test-ctr/reference/400.md) - [403](https://techdocs.akamai.com/test-ctr/reference/403.md) - [404](https://techdocs.akamai.com/test-ctr/reference/404.md) - [405](https://techdocs.akamai.com/test-ctr/reference/405.md) - [415](https://techdocs.akamai.com/test-ctr/reference/415.md) - [429](https://techdocs.akamai.com/test-ctr/reference/429.md) - [500](https://techdocs.akamai.com/test-ctr/reference/500.md) - [Submit a test run](https://techdocs.akamai.com/test-ctr/reference/post-test-runs.md): Submits a test run for functional testing. With one request you can run the test for a property version, test suite, and functional test case. - [List test runs](https://techdocs.akamai.com/test-ctr/reference/get-test-runs.md): Lists test runs submitted in your organization. The response is an array of objects, each keyed by `testRunId` with details and status of each test run. - [Get a test run](https://techdocs.akamai.com/test-ctr/reference/get-test-run.md): Returns details of a test run. Check [Functional testing results](doc:test-run-results#functional-testing-results) to learn how to analyze the results. - [Get test run's detailed results](https://techdocs.akamai.com/test-ctr/reference/get-test-run-raw-request-response.md): Gets a raw request and response for all URLs in a test run. - [Create a test suite](https://techdocs.akamai.com/test-ctr/reference/post-test-suites.md): Creates an empty test suite. To add objects to the newly created test suite, run the [Add test cases to a test suite](ref:post-test-cases) and [Add variables to a test suite](ref:post-variables) operations. - [List test suites](https://techdocs.akamai.com/test-ctr/reference/get-test-suites.md): Lists test suites created in your organization. The list can also include deleted test suites you can restore. The response contains an array of objects, each keyed by `testSuiteId`. You can use these IDs to [Get a test suite with child objects](ref:get-test-suites-with-child-objects). - [Generate a test suite with child objects](https://techdocs.akamai.com/test-ctr/reference/post-auto-generate-test-suite.md): Generates a default test suite with test cases and variables for a specific property version and a URL. Based on property settings and its behaviors and the URL, Test Center generates a default test suite object with test cases and variables. You can modify the generated test suite and add it to Test Center using the [Create a test suite with child objects](ref:post-test-suites-with-child-objects) operation. - [Create a test suite with child objects](https://techdocs.akamai.com/test-ctr/reference/post-test-suites-with-child-objects.md): Creates a test suite with test cases and variables. You can use the [Generate a test suite with child objects](ref:post-auto-generate-test-suite) operation to create a default test suite for a property version and then import it with this operation. The operation responds with a [partial-success 207 response](ref:partial-success-responses). Once you create the test suite, you can continue adding more objects to it with the [Add test cases to a test suite](ref:post-test-cases) and [Add variables to a test suite](ref:post-variables) operations. - [Get a test suite](https://techdocs.akamai.com/test-ctr/reference/get-test-suite.md): Returns basic data about a test suite. To check test cases and variables included in the test suite, run the [Get a test suite with child objects](ref:get-test-suites-with-child-objects) operation. - [Update a test suite](https://techdocs.akamai.com/test-ctr/reference/put-test-suite.md): Updates basic settings of a test suite. To edit test cases and variables, run the [Update a test suite with child objects](ref:put-test-suites-with-child-objects) operation. - [Delete a test suite](https://techdocs.akamai.com/test-ctr/reference/delete-test-suite.md): Deletes a test suite and included child objects: test cases and variables. You can [restore](ref:post-test-suite-restore) test suites with child objects within 30 days of deleting them. - [Restore a test suite](https://techdocs.akamai.com/test-ctr/reference/post-test-suite-restore.md): Restores a deleted test suite and included child objects. You can run this operation within 30 days of deleting the test suite. - [Get a test suite with child objects](https://techdocs.akamai.com/test-ctr/reference/get-test-suites-with-child-objects.md): Exports a test suite with test cases and variables. - [Update a test suite with child objects](https://techdocs.akamai.com/test-ctr/reference/put-test-suites-with-child-objects.md): Updates a test suite and included test cases and variables. - [Add variables to a test suite](https://techdocs.akamai.com/test-ctr/reference/post-variables.md): Adds new variables to a test suite. You can use variables in a test request's URL or request headers and in condition expression, as a substitute of placeholders. To learn more, see [Variables](ref:variables-overview). The operation responds with a [partial-success 207 response](ref:partial-success-responses). - [List variables](https://techdocs.akamai.com/test-ctr/reference/get-variables.md): Lists variables created in a test suite. - [Update variables](https://techdocs.akamai.com/test-ctr/reference/put-variables.md): Updates variables in a test suite. The operation responds with a [partial-success 207 response](ref:partial-success-responses). - [Delete variables](https://techdocs.akamai.com/test-ctr/reference/post-remove-variables.md): Deletes unused variables from a test suite. The operation responds with a [partial-success 207 response](ref:partial-success-responses). - [Get a variable](https://techdocs.akamai.com/test-ctr/reference/get-variable.md): Returns details of a variable used in a test suite. - [Add test cases to a test suite](https://techdocs.akamai.com/test-ctr/reference/post-test-cases.md): Adds a list of new functional test cases to a test suite. Each test case consists of a test request, client profile, and condition. If you want to use variables within a condition or test request's URL or request header, [create the needed variables](ref:post-variables) first. The operation responds with a [partial-success 207 response](ref:partial-success-responses). - [List test cases](https://techdocs.akamai.com/test-ctr/reference/get-test-cases.md): Lists functional test cases included in a test suite. The list can also include deleted test cases that you can restore. The response is an array of objects, each keyed by `testCaseId`. - [Update test cases](https://techdocs.akamai.com/test-ctr/reference/put-test-cases.md): Updates functional test cases in a test suite. The operation responds with a [partial-success 207 response](ref:partial-success-responses). - [Reorder test cases in a test suite](https://techdocs.akamai.com/test-ctr/reference/put-order-test-case.md): Reorders functional test cases in a test suite. The order of test cases applies when running a test for stateful test suites. You need to provide target order for all test cases included in a test suite. To check the current order of test cases, run the [Get a test suite with child objects](ref:get-test-suites-with-child-objects) operation. - [Remove test cases](https://techdocs.akamai.com/test-ctr/reference/post-remove-test-case.md): Removes functional test cases with specific identifiers from a test suite. To get the identifiers, run the [List test cases](ref:get-test-cases) operation. The operation responds with a [partial-success 207 response](ref:partial-success-responses). - [Restore test cases](https://techdocs.akamai.com/test-ctr/reference/post-test-cases-restore.md): Restores functional test cases into a test suite. To get the `testCaseId` of the test case you want to restore, run the [List test cases](ref:get-test-cases) operation with `includeRecentlyDeleted` set to `true`. The operation responds with a [partial-success 207 response](ref:partial-success-responses). - [Get a test case](https://techdocs.akamai.com/test-ctr/reference/get-test-case.md): Returns details of a functional test case. - [Get the test catalog template](https://techdocs.akamai.com/test-ctr/reference/get-test-catalog-template.md): Returns the test catalog template used for creating conditions. To learn more, see [Test Center concepts](ref:test-center-concepts) and [Example: create a condition](ref:example-create-condition). - [List test conditions](https://techdocs.akamai.com/test-ctr/reference/get-test-conditions.md): Lists condition statements you can use for creating test cases. - [List test requests](https://techdocs.akamai.com/test-ctr/reference/get-test-requests.md): Lists test requests created in your organization. - [Check how functions work](https://techdocs.akamai.com/test-ctr/reference/post-try-it.md): Runs a created function on sample data to check whether it returns the expected value. A function is valid for use in a test case if the response's `results` value returns only one value. To learn more about functions and variables, see [Variables](ref:variables-overview). ## Recipes - [Check how functions work](https://techdocs.akamai.com/test-ctr/recipes/check-how-functions-work.md) - [Create a single variable](https://techdocs.akamai.com/test-ctr/recipes/create-a-single-variable.md) - [Create a test suite with child objects](https://techdocs.akamai.com/test-ctr/recipes/create-a-test-suite-with-child-objects.md) - [Create a variable group](https://techdocs.akamai.com/test-ctr/recipes/create-a-variable-group.md) - [Create test cases](https://techdocs.akamai.com/test-ctr/recipes/create-test-cases.md) - [Submit a test run for a property version](https://techdocs.akamai.com/test-ctr/recipes/submit-a-test-run-for-a-property-version.md) - [Submit a test run for a test case](https://techdocs.akamai.com/test-ctr/recipes/submit-a-test-run-for-a-test-case.md) - [Submit a test run for a test suite](https://techdocs.akamai.com/test-ctr/recipes/submit-a-test-run-for-a-test-suite.md) ## Changelog - [Mar 6, 2024 — Test Center API v1 and v2 sunset](https://techdocs.akamai.com/test-ctr/changelog/mar-6-2024.md) - [Aug 22, 2023 — Test Center API v3 GA](https://techdocs.akamai.com/test-ctr/changelog/aug-22-2023.md) - [Aug 1, 2023 — New UI launched and improved API (Beta) v3](https://techdocs.akamai.com/test-ctr/changelog/aug-1-2023.md) - [May 4, 2023 — Test Center v3 Beta improvements](https://techdocs.akamai.com/test-ctr/changelog/may-4-2023.md) - [Jan 05, 2023 — Test Center improvements](https://techdocs.akamai.com/test-ctr/changelog/jan-05-2023-test-center-improvements.md) # TrafficPeak Documentation > The TrafficPeak Observability Platform, available on Akamai Cloud, allows you to drill down into your TrafficPeak data to reveal trends and troubleshoot problems. ## Guides - [TrafficPeak overview](https://techdocs.akamai.com/trafficpeak/docs/trafficpeak-overview.md) - [About upgrades and maintenance](https://techdocs.akamai.com/trafficpeak/docs/upgrade-and-maintenance.md) - [Encryption](https://techdocs.akamai.com/trafficpeak/docs/encryption.md) - [Dashboards overview](https://techdocs.akamai.com/trafficpeak/docs/dashboards-overview.md) - [Customize dashboards](https://techdocs.akamai.com/trafficpeak/docs/customize-dashboards.md) - [Grafana query builder](https://techdocs.akamai.com/trafficpeak/docs/grafana-query-builder.md) - [Example dashboard query](https://techdocs.akamai.com/trafficpeak/docs/example-dashboard-query.md) - [Recommended query practices](https://techdocs.akamai.com/trafficpeak/docs/recommended-query-practices.md) - [TrafficPeak custom data source plugin for Grafana](https://techdocs.akamai.com/trafficpeak/docs/trafficpeak-custom-data-source-plugin-for-grafana.md) - [Data field reference](https://techdocs.akamai.com/trafficpeak/docs/data-field-reference.md) - [MCP Server](https://techdocs.akamai.com/trafficpeak/docs/mcp-server.md) - [Manage Grafana users](https://techdocs.akamai.com/trafficpeak/docs/manage-grafana-users.md) - [Configure alerting](https://techdocs.akamai.com/trafficpeak/docs/configure-alerting.md) ## Changelog - [October 2025 — Enhancements to dashboards, including new panels and features](https://techdocs.akamai.com/trafficpeak/changelog/october-2025-v11-trafficpeak-dashboard-enhancements.md) - [July 2025 — Ten new dashboards compatible with TrafficPeak Grafana Plugin](https://techdocs.akamai.com/trafficpeak/changelog/jul-2025-ten-new-dashboards.md) # Web Application Security Documentation > How to protect your websites and APIs against DDoS and malicious web application attacks. Also explore how to handle adversarial bots, client-side script attacks, and account takeover fraud. ## Guides - [Welcome to Web Application Security](https://techdocs.akamai.com/cloud-security/docs/welcome-to-cloud-security.md) - [Combined security platform setup](https://techdocs.akamai.com/cloud-security/docs/combined-security-platform-setup.md) - [Mitigate threats against your web applications](https://techdocs.akamai.com/cloud-security/docs/app-api-protector.md) - [Deploy a hybrid solution for consistent web applications security in all environments](https://techdocs.akamai.com/cloud-security/docs/deploy-a-hybrid-solution-for-consistent-web-applications-security-in-all-environments.md) - [App & API Protector Hybrid on Amazon Web Services](https://techdocs.akamai.com/cloud-security/docs/app-api-protector-hybrid-on-amazon-web-services.md) - [Supported regions](https://techdocs.akamai.com/cloud-security/docs/supported-regions.md) - [Prerequisites and user access](https://techdocs.akamai.com/cloud-security/docs/prerequisites-and-user-access.md) - [Create a Connection and a Security Configuration](https://techdocs.akamai.com/cloud-security/docs/create-a-connection-and-a-security-configuration.md) - [Manage tokens](https://techdocs.akamai.com/cloud-security/docs/manage-tokens.md) - [Deployment steps](https://techdocs.akamai.com/cloud-security/docs/deployment-steps.md): Deploy App & API Protector Hybrid Reverse Proxy on Amazon Web Services (AWS) with Amazon Machine Image (AMI). - [Troubleshooting](https://techdocs.akamai.com/cloud-security/docs/troubleshooting.md) - [Monitor Protector instances](https://techdocs.akamai.com/cloud-security/docs/monitor-protector-instances.md) - [Connection Configurations](https://techdocs.akamai.com/cloud-security/docs/connection-configurations.md) - [TLS and mTLS support](https://techdocs.akamai.com/cloud-security/docs/tls-and-mtls-support.md) - [VM image versioning](https://techdocs.akamai.com/cloud-security/docs/vm-image-versioning.md) - [Keep track of your Protector software versioning](https://techdocs.akamai.com/cloud-security/docs/keep-track-of-your-protector-software-versioning.md) - [Security Configurations](https://techdocs.akamai.com/cloud-security/docs/security-configurations.md) - [Set protections](https://techdocs.akamai.com/cloud-security/docs/set-protections.md) - [Monitor activity](https://techdocs.akamai.com/cloud-security/docs/monitor-activity.md): Track configuration effectiveness and adjust protections as needed. - [Upgrades](https://techdocs.akamai.com/cloud-security/docs/upgrades-1.md): Upgrade Protector in AWS-based deployment - [Shared Responsibility Model](https://techdocs.akamai.com/cloud-security/docs/shared-responsibility-model.md) - [About bots](https://techdocs.akamai.com/cloud-security/docs/about-bots.md) - [Detection methods](https://techdocs.akamai.com/cloud-security/docs/detection-methods.md) - [Handle adversarial bots](https://techdocs.akamai.com/cloud-security/docs/handle-adversarial-bots.md) - [Thwart web scrapers](https://techdocs.akamai.com/cloud-security/docs/thwart-web-scrapers.md) - [Prevent account abuse](https://techdocs.akamai.com/cloud-security/docs/account-protector.md) - [Protect your AI apps](https://techdocs.akamai.com/cloud-security/docs/protect-your-ai-apps.md) - [Protect your site against web skimming attacks](https://techdocs.akamai.com/cloud-security/docs/page-integrity-manager.md) - [Protect your brand](https://techdocs.akamai.com/cloud-security/docs/brand-protector.md) - [Overview](https://techdocs.akamai.com/cloud-security/docs/overview.md) - [Protect APIs with App & API Protector](https://techdocs.akamai.com/cloud-security/docs/apply-protections-to-your-api.md) - [API Security service](https://techdocs.akamai.com/cloud-security/docs/api-security-service.md) - [Responsible use of AI in App & API Protector and related solutions](https://techdocs.akamai.com/cloud-security/docs/responsible-use-of-ai-in-application-security-solutions.md) ## Changelog - [Jun 17, 2026 - App & API Protector Hybrid: IP/Geo Firewall and Client Lists are now available](https://techdocs.akamai.com/cloud-security/changelog/jun-17-2026-app-api-protector-hybrid-ipgeo-firewall-and-client-lists-are-now-available.md) - [May 19, 2026 - Usage-based billing now available for App & API Protector Hybrid reverse proxy deployment in AWS Marketplace](https://techdocs.akamai.com/cloud-security/changelog/may-19-2026-usage-based-billing-now-available-for-app-api-protector-hybrid-reverse-proxy-deployment-in-aws-marketplace.md) - [Feb 23, 2026 - App & API Protector Hybrid: SIEM integration is now available](https://techdocs.akamai.com/cloud-security/changelog/feb-23-2026-siem-integration-is-now-available.md) - [Feb 2, 2026 - App & API Protector Hybrid Reverse Proxy VM now generally available](https://techdocs.akamai.com/cloud-security/changelog/feb-2-2026-app-api-protector-hybrid-reverse-proxy-vm-now-generally-available.md) - [Dec 8, 2025 - App & API Protector Hybrid: Rate limiting for application layer is now available](https://techdocs.akamai.com/cloud-security/changelog/dec-8-2025-rate-limiting-for-application-layer-is-now-available.md) # Zero Trust Client Documentation > Zero Trust Client integrates data path protection, identity access, multi-factor authentication, application security, management visibility, and control for applications hosted in data centers and hybrid cloud environments. Using it, the management and control of remote access for employees, contractors, and partners becomes less complex and more secure. This robust tool delivers access to applications without allowing user access to the entire network. Applications are not accessed directly because they are hidden from the Internet and public exposure. A unique dual-cloud architecture closes all inbound firewall ports while providing authenticated end users with access to only their own special applications. Threat Protection offers a cloud-based, targeted threat protection solution that safeguards your organization from DNS and web-based threats, enforces authentication and acceptable use policies, and audits user Internet access. Segmentation lets you control access, implement security policies, and maintain segmentation throughout your entire environment. ## Guides - [Welcome to Zero Trust Client](https://techdocs.akamai.com/zero-trust-client/docs/welcome.md) - [About Access, Threat Protection, and Segmentation](https://techdocs.akamai.com/zero-trust-client/docs/about-aztc.md) - [Zero Trust Client rollout process](https://techdocs.akamai.com/zero-trust-client/docs/zero-trust-client-rollout-process.md) - [Requirements](https://techdocs.akamai.com/zero-trust-client/docs/requirements.md) - [Prepare for Zero Trust Client setup](https://techdocs.akamai.com/zero-trust-client/docs/prepare-for-ztc-setup.md) - [Forward proxy support](https://techdocs.akamai.com/zero-trust-client/docs/proxy-support.md) - [Set up Threat Protection](https://techdocs.akamai.com/zero-trust-client/docs/set-threat-protection.md) - [Set up Zero Trust Client](https://techdocs.akamai.com/zero-trust-client/docs/install-aztc.md) - [Configure the client](https://techdocs.akamai.com/zero-trust-client/docs/configure-aztc.md) - [Uninstall the client](https://techdocs.akamai.com/zero-trust-client/docs/uninstall-aztc.md) - [Rollback to the standalone EAA or ETP Client](https://techdocs.akamai.com/zero-trust-client/docs/rollback-to-the-standalone-eaa-or-etp-client.md) - [Multi-user support](https://techdocs.akamai.com/zero-trust-client/docs/multi-user-support.md) - [Basic operations](https://techdocs.akamai.com/zero-trust-client/docs/aztc-basic-operations.md) - [Advanced features](https://techdocs.akamai.com/zero-trust-client/docs/aztc-advanced-features.md) - [Contextual menu, icons, and client status](https://techdocs.akamai.com/zero-trust-client/docs/client-icons-and-network-states.md) - [About Zero Trust Client for mobile](https://techdocs.akamai.com/zero-trust-client/docs/about-zero-trust-client-for-mobile.md) - [Requirements](https://techdocs.akamai.com/zero-trust-client/docs/client-requirements-mobile.md) - [Limitations](https://techdocs.akamai.com/zero-trust-client/docs/limitations.md) - [Distribute the mobile client](https://techdocs.akamai.com/zero-trust-client/docs/distribute-mobile-zero-trust-client.md) - [Distribute the mobile client with Microsoft Intune](https://techdocs.akamai.com/zero-trust-client/docs/distribute-the-mobile-client-with-microsoft-intune.md) - [Distribute the mobile client with Workspace ONE UEM](https://techdocs.akamai.com/zero-trust-client/docs/distribute-the-mobile-client-with-workspace-one-uem.md) - [Distribute the mobile client with JAMF](https://techdocs.akamai.com/zero-trust-client/docs/distribute-the-mobile-client-with-jamf.md) - [Distribute the mobile client with Google Workspace](https://techdocs.akamai.com/zero-trust-client/docs/distribute-the-mobile-client-with-google-workspace.md) - [Set up Zero Trust Client Mobile](https://techdocs.akamai.com/zero-trust-client/docs/install-zero-trust-client-mobile.md) - [Install SIA Proxy MITM certificate](https://techdocs.akamai.com/zero-trust-client/docs/install-sia-proxy-mitm-certificate.md) - [Configure the mobile client](https://techdocs.akamai.com/zero-trust-client/docs/configure-zero-trust-client-mobile.md) - [Use the mobile client](https://techdocs.akamai.com/zero-trust-client/docs/use-zero-trust-client-mobile.md) - [Manage Zero Trust Client](https://techdocs.akamai.com/zero-trust-client/docs/manage-client-versions.md) - [Configure Threat Protection](https://techdocs.akamai.com/zero-trust-client/docs/configure-threat-protection.md) - [Transparent traffic interception](https://techdocs.akamai.com/zero-trust-client/docs/transparent-traffic-interception.md) - [View Client Inventory](https://techdocs.akamai.com/zero-trust-client/docs/aztc-ec-user-inv.md) - [View device details](https://techdocs.akamai.com/zero-trust-client/docs/view-user-and-device-details.md) - [Desktop client](https://techdocs.akamai.com/zero-trust-client/docs/troubleshoot-akamai-zero-trust-client.md) - [Known issues, caveats, and limitations](https://techdocs.akamai.com/zero-trust-client/docs/known-issues-caveats-and-limitations.md) - [Mobile client](https://techdocs.akamai.com/zero-trust-client/docs/troubleshooting.md) ## Changelog - [Jun 18, 2026 — Akamai Zero Trust Client Mobile 3.3.1 for Android and ChromeOS](https://techdocs.akamai.com/zero-trust-client/changelog/jun-18-2026-akamai-zero-trust-client-mobile-331-for-android-and-chromeos.md) - [Jun 11, 2026 — Akamai Zero Trust Client 5.x and 6.x End of Support](https://techdocs.akamai.com/zero-trust-client/changelog/jun-11-2026-akamai-zero-trust-client-6x-end-of-support.md) - [June 10, 2026 — Akamai Zero Trust Client Mobile 3.3 for Android and ChromeOS](https://techdocs.akamai.com/zero-trust-client/changelog/june-10-2026-akamai-zero-trust-client-mobile-33-for-android.md) - [June 5, 2026 — Akamai Zero Trust Client Mobile 3.3 for iOS and iPadOS](https://techdocs.akamai.com/zero-trust-client/changelog/june-5-2026-akamai-zero-trust-client-mobile-33-for-ios-and-ipados.md) - [Apr 9, 2026 — Akamai Zero Trust Client 6.1.6 general availability](https://techdocs.akamai.com/zero-trust-client/changelog/apr-9-2026-akamai-zero-trust-client-616-general-availability.md) # Zero Trust Security Documentation > Akamai's Zero Trust Network Access (ZTNA) draws upon a set of rules that form a policy that in turn determines whether or not to allow access to your organization’s network or apps. Learn how to create policies based on the Zero Trust paradigm. ## Guides - [Welcome to Zero Trust Security](https://techdocs.akamai.com/zero-trust-security/docs/welcome-to-zero-trust-security.md) - [Create effective segmentation security policies](https://techdocs.akamai.com/zero-trust-security/docs/segmentation-policies.md) # Akamai TechDocs Documentation > Find guides, APIs, Terraform, code examples, and more for Akamai products and services. ## Pages - [Akamai discontinued products and services](https://techdocs.akamai.com/home/akamai-discontinued-products.md) - [Akamai APIs](https://techdocs.akamai.com/home/apis.md)