EdgeWorkers

Learn how to execute JavaScript functions at the edge to optimize site performance and customize web experiences.

Get Started    

Manage EdgeWorkers

You can use the EdgeWorkers Management application to perform the administrative tasks required to execute EdgeWorkers functions with a user interface (UI).

Access the EdgeWorkers Management application

  1. Log in to Control Center.

  2. Go to > CDN > EdgeWorkers.

Create an EdgeWorker version

Create an EdgeWorker version when you want to activate a new EdgeWorkers code bundle or update an existing EdgeWorkers code bundle.

To complete this step, you need a code bundle.

  1. From the EdgeWorkers details page, click on an EdgeWorker ID or name.

    Only the EdgeWorkers you have permission to access appear in the list.

  2. Click the Create version button.

    Create EdgeWorker versionCreate EdgeWorker version

  3. Drag and drop the code bundle onto the window and click the Create version button.

Activate an EdgeWorker version

Once you have created an EdgeWorker version you can activate it on your staging or production network. Only one EdgeWorker version can be active on the staging network and only one can be active on the production network. When the activation process is complete, the previously activated version becomes inactive. An inactive version can be re-activated.

  1. From the EdgeWorker versions page, select the EdgeWorker version you want to activate.

  2. Click the Activate version button.

  3. Select the network where you want to activate the version.

    You can use the staging network to validate the behavior of your code. Once you've tested the functionality, you can activate it on the production network.

👍

To deactivate an active EdgeWorker version selection the version you want to deactivate. You can then click the Deactivate version button.

View the version history

Use the EdgeWorkers Management application to view the activation and deactivation history for an EdgeWorker ID.

  1. Select an EdgeWorker ID from the EdgeWorker details page.

  2. Select Activation history or Deactivation history tab.

  3. View the details that appear in the Current status column.

    Review the table for information about each status.

Status

Description

Activating

The version is currently activating.

Deactivating

The current version is currently deactivating.

Active

The version is active. Only one version can be active at a time.

Blocked

​Akamai​ cannot determine if the EdgeWorker code bundle was successfully deployed to the edge server. When this occurs, ​Akamai​ prevents the activation from completing. The previously activated EdgeWorker version remains active.

Error

An error is detected during the activation or deactivation process.

Deactivated

The EdgeWorker version is deactivated. This status can also appear if the EdgeWorkers code bundle is deactivated due to a possible network issue. Contact support for more information.

Inactive

The version is currently inactive. This status appears when an EdgeWorker version has not yet been activated or when a deactivation is complete.

Complete

The version activation or deactivation is complete.

View the resource tiers details

Use the EdgeWorkers Management application to view the resource tier selected for an EdgeWorker ID.

  1. Select an EdgeWorker ID from the EdgeWorkers details page.

  2. Select the Resource Tiers tab.

  3. The details for the selected EdgeWorker ID appear in the tab.

📘

By default, all EdgeWorker IDs created before resource tiers were introduced, execute using the Dynamic Compute resource tier.

You can contact your ​Akamai​ account representative for more information about billing. For instructions on how to change the resource tier assigned to an EdgeWorkers function see Clone an EdgeWorker ID below.

Clone an EdgeWorker ID

To change the resource tier of an EdgeWorkers function, you need to clone the EdgeWorker ID.

  1. Select an EdgeWorker ID from the EdgeWorkers details page and click the Edit EdgeWorker ID button.

  2. Select the edit link beside the Resource tier field to open the Clone EdgeWorker ID window.

  3. Select a new resource tier for your EdgeWorker ID.

    By default, all EdgeWorker IDs created before resource tiers were introduced, execute using Dynamic Compute. You can however, change an EdgeWorkers function to Basic Compute, a less costly tier with lower limits.

🚧

Review the Resource tier limitations for each resource tier before cloning an EdgeWorker ID. It is important to make sure that the EdgeWorkers function can successfully execute when lowering the resource limits. If the execution is unsuccessful the timeout error rate may significantly increase. This can adversely impact your delivery traffic.

  1. Click the Clone EdgeWorker ID button.

  2. Once you have cloned your EdgeWorker ID you can create and activate EdgeWorker versions.

Delete an EdgeWorker ID

When you delete an EdgeWorker ID it is permanently removed from your account. It also deletes all versions, code bundles, and the activation and deactivation history associated with the EdgeWorker ID.

👍

See Delete an EdgeWorker version if you want to delete a version from an EdgeWorker ID.

  1. Select the EdgeWorker ID you want to delete from the list of EdgeWorker IDs.

  2. Click the Delete button on the EdgeWorkers details page.

  3. Click the Search active properties button to check for active versions associated with the EdgeWorker ID on your properties.

    You can only delete an EdgeWorker ID if none of its versions are active on staging or production.

    Only users with access to all properties should delete an EdgeWorker ID. If you don’t have access to view all properties you’ll receive notification after you click the Search active properties button.

🚧

You shouldn't delete an EdgeWorker ID if one or more active properties are using it. Doing so can cause issues in your Property Manager configuration.
You can, however, deactivate the active property that is using the EdgeWorker ID. You won't be able to re-activate this property once the EdgeWorker ID is deleted.

  1. Select the check box to confirm that you have checked to make sure that the EdgeWorker ID isn’t active on any active properties.

  2. Click the Delete EdgeWorker ID button.

Delete an EdgeWorker version

When you delete an EdgeWorker version it is permanently removed from the EdgeWorker ID. It also deletes the activation and deactivation history of the version. You can only delete a deactivated EdgeWorker version. Active or activating versions cannot be deleted.

  1. Select the EdgeWorker ID that contains the version that you want to delete.

  2. Click on the EdgeWorker version and select Delete version from the Actions menu.

    If the EdgeWorker version is active on the staging or production network you will receive a warning message.

    1. To deactivate an EdgeWorker version go to the EdgeWorker ID details page and click on the Versions tab.

    2. Find the version number you want to delete and select Deactivate version from the Actions menu.

View Properties

You can view the active and inactive properties using an existing EdgeWorker ID. This information can be useful when deleting an EdgeWorker ID.

  1. Select an EdgeWorker ID.

  2. Click on the Properties tab on the EdgeWorker details page.

    These fields are blank if the EdgeWorker ID is not active on any properties.

Field

Description

ID

The property ID.

Name

The name of the property where the EdgeWorker ID is active.

Latest version

The latest property version available.

This version may not be active on the staging or production network. It is the last version created.

Active stating version

The property version active on the staging network.

Active production version

The property version active on the production network.

Updated 4 months ago


Manage EdgeWorkers


Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.