Home
Administration
Enable the EdgeWorkers service for your Akamai properties.
Manage EdgeWorkers with the API
Use this section as a high level overview of how to activate and update an EdgeWorker version using the API.
View EdgeWorker permissions with the API
See a list of groups and the associated permission capabilities.

Welcome to EdgeWorkers
Learn how to use the EdgeWorkers service to optimize your content delivery.
Get started
Get an EdgeWorkers function up and running on your site using a Hello World use case.
Administration
Enable the EdgeWorkers service for your Akamai properties.
- Add entitlement to your contract
  Confirm you have the entitlement for the EdgeWorkers service in your contract.
- Resource tiers
  Resource tiers let you select between different sets of resource consumption limits for your EdgeWorker functions.
- EdgeWorker roles
  Use EdgeWorkers roles to create and manage access to EdgeWorkers.
- Create an EdgeWorker ID
  An EdgeWorker ID is required to turn on the EdgeWorkers behavior in your Akamai property configuration.
- Add the EdgeWorkers behavior
  Use Property Manager to turn on the behavior in your Akamai property configuration.
- Manage EdgeWorkers with the EdgeWorkers Management application
  The EdgeWorkers Management application lets you perform the administrative tasks required to execute EdgeWorkers functions with a user interface (UI).
- Manage EdgeWorkers with the API
  Use this section as a high level overview of how to activate and update an EdgeWorker version using the API.
  - Create an API client
    Create an authentication token for the EdgeWorkers API.
  - Create an EdgeWorker version with the API
    Update your code by creating a new version.
  - Activate an EdgeWorker version with the API
    Activate your code on the staging or production network.
  - View EdgeWorker permissions with the API
    See a list of groups and the associated permission capabilities.
- Failover
  Failover lets you define what logic to execute in the event that an Edgeworker function fails.
Developer tools
Use any tooling compatible with ES2015 JavaScript to code, build, package, and test your EdgeWorkers.
Development
Find best practices for using the EdgeWorkers service to enhance your website functionality.
JavaScript reference
Review these details when designing EdgeWorkers functions.
Monitor
Use built-in reports to gain insight about the performance and execution status of your EdgeWorker functions.
Troubleshoot
Find information about debugging, error codes, and how to resolve common errors.
Limitations
Keep these limitations in mind when designing your EdgeWorker functions.
EdgeWorkers GitHub Repo
Find practical examples to use as a starting point for your Akamai EdgeWorkers.
FAQs
Find answers to commonly-asked questions about EdgeWorkers.
Notice

View EdgeWorker permissions with the API

See a list of groups and the associated permission capabilities.

Before you begin

To complete this task, you’ll need an API client with EdgeWorkers credentials.

Find out which permissions EdgeWorkers functions have within the Control Center group.

How to

Enter this command to see a list of groups and the associated permission capabilities.

GET /edgeworkers/v1/groups

{
    "groups": [
        {
            "groupId": 4284,
            "groupName": "Group #42",
            "capabilities": [
                "VIEW",
                "VIEW_VERSION",
                "VIEW_ACTIVATION",
                "ACTIVATE"
            ]
        },
        {
            "groupId": 109795,
            "groupName": "ESSL Behavior Tests",
            "capabilities": [
                "VIEW",
                "EDIT",
                "VIEW_VERSION",
                "CREATE_VERSION",
                "VIEW_ACTIVATION",
                "ACTIVATE"
            ]
        }
    ]
}

Select a groupId from the response object, then issue a GET request.

GET /edgeworkers/v1/ids{?groupId}

Look at the response object for details on the capabilities enabled within a specified group.

{
    "groupId": 109795,
    "groupName": "ESSL Behavior Tests",
    "capabilities": [
        "VIEW",
        "VIEW_VERSION",
        "VIEW_ACTIVATION"
    ]
}