EdgeWorkers API v1

Execute JavaScript at the edge to optimize performance and customize web experiences.

Learn more:


Overview

The EdgeWorkers service lets you run JavaScript at the edge of the Internet to dynamically manage web traffic. You can use the EdgeWorkers API to deploy custom code on thousands of Akamai edge servers and apply logic that creates powerful web experiences.

Use the EdgeWorkers service to:

  • Redirect requests based on geography, device, and user-agent.

  • Apply conditional logic to filter requests and construct responses.

  • Customize error responses to improve web experiences, even when the origin is down.

  • Add or remove debug information from HTTP responses.

Get started

To use this API for the first time:

  • Confirm that you have the entitlement for the EdgeWorkers service in your contract. EdgeWorkers is available for customers with Akamai ION and Dynamic Site Accelerator products.

  • Review Get Started with APIs for instructions on setting up authentication tokens to access any Akamai API. These tokens appear as custom hostnames that look like this: https://akzz-XXXXXXXXXXXXXXXX-XXXXXXXXXXXXXXXX.luna.akamaiapis.net. To enable this API, select the API service named EdgeWorkers, and choose READ-WRITE as the access level.

  • Add a rule in Property Manager to enable the EdgeWorkers behavior. Follow the instructions in the User Guide

EdgeWorkers bundle format

To create the EdgeWorkers bundle, you need a JavaScript source file called main.js that contains event handler definitions for when to execute the code:

  • onClientRequest. This event happens for every request as the request is received, before checking if a response is available in cache.

  • onOriginRequest. This event happens just before sending the request to the origin.

  • onOriginResponse. This event happens as the origin response is created.

  • onClientResponse. This event happens for every request just before the client response is sent.

You also need to create a manifest file called bundle.json that includes meta information as described in the table below.

Name Type Description Required
edgeworker-version String Unique identifier for the EdgeWorkers version.
bundle-version Integer Bundle format version.
api-version String Version of JavaScript API when the EdgeWorkers code was created.
description String Phrase describing the EdgeWorkers script function.
misc Object Information you can include in the manifest to identify the EdgeWorkers function.

NOTE: For edgeworker-version limit characters to alphanumeric, underscore, dash, dot, and tilde.

{
    "edgeworker-version":"4.22.3",
    "bundle-version":1,
    "api-version":"0.3",
    "description":"Language Redirect",
    "misc":{
        "author":"jsmith",
        "git-commit":"4ce52c8ff4fdd1771e5347297ea5691b55c4f6ed",
        "updated":"2027-09-23"
    }
}

Resource limiting

This API imposes limits on some of the resources you can deploy.

Description Limit
Number of activated EdgeWorker scripts per account 200
Number of EdgeWorker scripts per request 1
Compressed size for a script bundle 512 KB (524288 bytes)
Uncompressed size for a script bundle 1 MB (1048576 bytes)
HTTP response body size 2048 characters

Resources

Here are some terms and concepts that will help you understand how to use this API.

  • ID: The EdgeWorkers API generates a unique edgeWorkerId, a numeric identifier that enables you to activate and manage your EdgeWorkers scripts.

  • Group: Contains information about what EdgeWorker capabilities and permissions are allowed within the group.

  • Version: A unique string value that enables you to track revision history for an edgeWorkerId. Each version refers to a specific bundle that contains your EdgeWorker script.

  • Activation: EdgeWorkers code, identified by edgeWorkerId+version, set to execute on the Akamai staging or production network.

  • Script Bundle: A collection of files including main.js, the JavaScript source that contains event handler functions, and bundle.json packaged together in a compressed .tgz file. See EdgeWorkers bundle format for details.

API summary

Download the RAML descriptors for this API.

Operation Method Endpoint
Groups  
List permission groups GET /edgeworkers/v1/groups
Get a permission group GET /edgeworkers/v1/groups/{groupId}
EdgeWorker IDs  
List EdgeWorker IDs GET /edgeworkers/v1/ids{?groupId}
Create a new EdgeWorker ID POST /edgeworkers/v1/ids
Get an EdgeWorker GET /edgeworkers/v1/ids/{edgeWorkerId}
Update an EdgeWorker PUT /edgeworkers/v1/ids/{edgeWorkerId}
Versions  
List versions GET /edgeworkers/v1/ids/{edgeWorkerId}/versions
Create a new version POST /edgeworkers/v1/ids/{edgeWorkerId}/versions
Get version details GET /edgeworkers/v1/ids/{edgeWorkerId}/versions/{version}
Download an EdgeWorker bundle GET /edgeworkers/v1/ids/{edgeWorkerId}/versions/{version}/content
Activations  
List activations GET /edgeworkers/v1/ids/{edgeWorkerId}/activations{?version}
Activate an EdgeWorker version POST /edgeworkers/v1/ids/{edgeWorkerId}/activations
Get an activation GET /edgeworkers/v1/ids/{edgeWorkerId}/activations/{activationId}

List permission groups

View a list of groups and the associated permission capabilities, for example: activate a version or fetch an EdgeWorker ID.

GET /edgeworkers/v1/groups

Status 200 application/json

Object type: Permissions

Download schema: groups.json

Response body:

{
    "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"
            ]
        }
    ]
}

Get a permission group

View details on the capabilities enabled within a specified group, for example: activate a version or fetch an EdgeWorker ID.

GET /edgeworkers/v1/groups/{groupId}

Sample: /edgeworkers/v1/groups/109795

Parameter Type Sample Description
URL path parameters
groupId Number 109795 Unique identifier for an EdgeWorker group. You can pass in plain integer IDs, or add a grp_ prefix. The Property Manager API supports both formats. See ID prefixes for details.

Status 200 application/json

Object type: Permissions

Download schema: group.json

Response body:

{
    "groupId": 109795,
    "groupName": "ESSL Behavior Tests",
    "capabilities": [
        "VIEW",
        "VIEW_VERSION",
        "VIEW_ACTIVATION"
    ]
}
  1. Run the List groups operation.

  2. Select a groupId from the Permissions response object, then make a GET request to /edgeworkers/v1/groups/{groupId}.

List EdgeWorker IDs

View the list of EdgeWorkers in the identified group.

GET /edgeworkers/v1/ids{?groupId}

Sample: /edgeworkers/v1/ids?groupId=72297

Parameter Type Sample Description
Optional query parameters
groupId Integer 72297 Unique identifier for the Akamai group containing the EdgeWorker.

Status 200 application/json

Object type: EdgeWorker

Download schema: ids.json

Response body:

{
    "edgeWorkerIds": [
        {
            "edgeWorkerId": 1,
            "name": "Ew_1",
            "accountId": "B-M-1KQK3WU",
            "groupId": 72297,
            "createdBy": "jsmith",
            "createdTime": "2018-10-15T14:49:40Z",
            "lastModifiedBy": "jsmith",
            "lastModifiedTime": "2018-10-15T15:21:15Z"
        },
        {
            "edgeWorkerId": 2,
            "name": "EdgeWorker #2",
            "accountId": "B-M-1KQK3WU",
            "groupId": 72297,
            "createdBy": "jsmith",
            "createdTime": "2018-10-15T16:54:40Z",
            "lastModifiedBy": "jsmith",
            "lastModifiedTime": "2018-10-15T16:54:40Z"
        }
    ]
}
  1. Run the List groups operation.

  2. Select a groupId from the Permissions response object, then make a GET request to /edgeworkers/v1/ids{?groupId}.

  3. Look in the response EdgeWorker object for attributes associated with each EdgeWorker in the group.

Create a new EdgeWorker ID

Register a new EdgeWorker within a particular group.

POST /edgeworkers/v1/ids

Content-Type: application/json

Object type: EdgeWorker

Download schema: ids-post-request.json

Request body:

{
    "groupId": 72297,
    "name": "Ew_42"
}

Status 201 application/json

Headers:

Location: https://akzz-XXXXXXXXXXXXXXXX-XXXXXXXXXXXXXXXX.luna.akamaiapis.net/edgeworkers/v1/edgeworkers/42

Object type: EdgeWorker

Download schema: id.json

Response body:

{
    "edgeWorkerId": 42,
    "name": "Ew_42",
    "accountId": "B-M-1KQK3WU",
    "groupId": 72297,
    "createdBy": "jsmith",
    "createdTime": "2018-10-15T14:49:40Z",
    "lastModifiedBy": "jsmith",
    "lastModifiedTime": "2018-10-15T15:21:15Z"
}
  1. Run the Get a group operation to get the groupId associated with the EdgeWorker.

  2. Create a JSON request body that includes the groupId and a name.

  3. POST the object to /edgeworkers/v1/ids.

  4. Optionally store the Location response header, which tells you where to GET the new EdgeWorker ID from.

  5. View the response EdgeWorker object for details on the registered EdgeWorker.

Get an EdgeWorker

View details for a specific EdgeWorker.

GET /edgeworkers/v1/ids/{edgeWorkerId}

Sample: /edgeworkers/v1/ids/42

Parameter Type Sample Description
URL path parameters
edgeWorkerId Integer 42 Unique identifier of the EdgeWorker.

Status 200 application/json

Object type: EdgeWorker

Download schema: id.json

Response body:

{
    "edgeWorkerId": 42,
    "name": "Ew_1",
    "accountId": "B-M-1KQK3WU",
    "groupId": 72297,
    "createdBy": "jsmith",
    "createdTime": "2018-10-15T14:49:40Z",
    "lastModifiedBy": "jsmith",
    "lastModifiedTime": "2018-10-15T15:21:15Z"
}
  1. Run the List EdgeWorker IDs operation.

  2. Select an edgeWorkerId from the EdgeWorker members response object, then make a GET request to /edgeworkers/v1/ids/{edgeWorkerId}.

Update an EdgeWorker

Update the name or groupId of an existing EdgeWorker.

PUT /edgeworkers/v1/ids/{edgeWorkerId}

Sample: /edgeworkers/v1/ids/42

Content-Type: application/json

Object type: EdgeWorker

Download schema: id-put-request.json

Request body:

{
    "groupId": 123456,
    "name": "New EdgeWorker Name"
}
Parameter Type Sample Description
URL path parameters
edgeWorkerId Integer 42 Unique identifier of the EdgeWorker.

Status 200 application/json

Object type: EdgeWorker

Download schema: id.json

Response body:

{
    "edgeWorkerId": 42,
    "name": "New EdgeWorker Name",
    "accountId": "B-M-1KQK3WU",
    "groupId": 72297,
    "createdBy": "jsmith",
    "createdTime": "2018-10-15T14:49:40Z",
    "lastModifiedBy": "jsmith",
    "lastModifiedTime": "2018-10-15T15:21:15Z"
}
  1. Run the List EdgeWorker IDs operation.

  2. Select an edgeWorkerId from the EdgeWorker members response object, then make a GET request to /edgeworkers/v1/ids/{edgeWorkerId}.

  3. Modify the name of the EdgeWorker in the response using this syntax "name": "New EdgeWorker Name".

  4. PUT the object to /edgeworkers/v1/ids/{edgeWorkerId}.

List versions

View a list of EdgeWorker versions.

GET /edgeworkers/v1/ids/{edgeWorkerId}/versions

Sample: /edgeworkers/v1/ids/42/versions

Parameter Type Sample Description
URL path parameters
edgeWorkerId Integer 42 Unique identifier for an EdgeWorker.

Status 200 application/json

Object type: Version

Download schema: versions.json

Response body:

{
    "versions": [
        {
            "edgeWorkerId": 42,
            "version": 1,
            "accountId": "B-M-1KQK3WU",
            "checksum": "de9f2c7fd25e1b3afad3e85a0bd17d9b100db4b3",
            "createdBy": "jsmith",
            "createdTime": "2018-07-05T18:17:46Z"
        },
        {
            "edgeWorkerId": 42,
            "version": 2,
            "accountId": "B-M-1KQK3WU",
            "checksum": "8277e0910d750195b448797616e091ad616e091a",
            "createdBy": "jsmith",
            "createdTime": "2018-07-05T23:01:34Z"
        }
    ]
}
  1. Run the List EdgeWorker IDs operation.

  2. Select an edgeWorkerId from the EdgeWorker members response object, then make a GET request to /edgeworkers/v1/ids/{edgeWorkerId}/versions.

  3. View the details of the Version members in the response object.

Create a new version

Create a new version of an EdgeWorker.

POST /edgeworkers/v1/ids/{edgeWorkerId}/versions

Sample: /edgeworkers/v1/ids/42/versions

Content-Type: application/gzip

Request body:

(Body specifies GZIP binary data.)
Parameter Type Sample Description
URL path parameters
edgeWorkerId Integer 42 Unique identifier for an EdgeWorker.

Status 201 application/json

Headers:

Location: https://akzz-XXXXXXXXXXXXXXXX-XXXXXXXXXXXXXXXX.luna.akamaiapis.net/edgeworkers/v1/edgeworkers/42/versions/5

Object type: Version

Download schema: version.json

Response body:

{
    "edgeWorkerId": 42,
    "version": 5,
    "accountId": "B-M-1KQK3WU",
    "checksum": "de9f2c7fd25e1b3afad3e85a0bd17d9b100db4b3",
    "createdBy": "jsmith",
    "createdTime": "2018-07-05T18:17:46Z"
}
  1. Run the List EdgeWorker IDs operation and select an edgeWorkerId from the EdgeWorker response object.

  2. Build the script bundle, specifying the edgeworker-version as described in EdgeWorkers bundle format.

  3. POST the script bundle to /edgeworkers/v1/ids/{edgeWorkerId}/versions.

  4. Optionally store the Location response header, which tells you where to GET the new version from.

  5. The operation responds with a Version object, which reflects the new version.

Get version details

View details for a specific version.

GET /edgeworkers/v1/ids/{edgeWorkerId}/versions/{version}

Sample: /edgeworkers/v1/ids/42/versions/5

Parameter Type Sample Description
URL path parameters
edgeWorkerId Integer 42 Unique identifier for an EdgeWorker.
version String 5 Unique identifier for an EdgeWorker version.

Status 200 application/json

Object type: Version

Download schema: version.json

Response body:

{
    "edgeWorkerId": 42,
    "version": 3,
    "accountId": "B-M-1KQK3WU",
    "checksum": "de9f2c7fd25e1b3afad3e85a0bd17d9b100db4b3",
    "createdBy": "jsmith",
    "createdTime": "2018-07-09T21:51:07Z"
}
  1. Run the List EdgeWorker IDs operation and select an edgeWorkerId from the EdgeWorker members response object.

  2. Run the List versions operation and select a version from the Version members response object.

  3. Make a GET request to /edgeworkers/v1/ids/{edgeWorkerId}/versions/{version}.

Download an EdgeWorker bundle

Download the bundle containing the code the EdgeWorker executes.

GET /edgeworkers/v1/ids/{edgeWorkerId}/versions/{version}/content

Sample: /edgeworkers/v1/ids/42/versions/5/content

Parameter Type Sample Description
URL path parameters
edgeWorkerId Integer 42 Unique identifier for an EdgeWorker.
version String 5 Unique identifier for an EdgeWorker version.

Status 200 application/gzip

Response body:

(Body specifies GZIP binary data.)
  1. Run the List EdgeWorker IDs operation and select an edgeWorkerId from the EdgeWorker members response object.

  2. Run the List versions operation and select a version from the Version members response object.

  3. Make a GET request to /edgeworkers/v1/ids/{edgeWorkerId}/versions/{version}/content.

  4. Open the downloaded file to see the JavaScript code for the EdgeWorker.

List activations

View the list of activations for an existing EdgeWorker based on ID. You can choose to specify the version in the request.

GET /edgeworkers/v1/ids/{edgeWorkerId}/activations{?version}

Sample: /edgeworkers/v1/ids/42/activations?version=5

Parameter Type Sample Description
URL path parameters
edgeWorkerId Integer 42 Unique identifier for an EdgeWorker.
Optional query parameters
version String 5 Unique identifier for a specific EdgeWorker version.

Status 200 application/json

Object type: Activation

Download schema: activations.json

Response body:

{
    "activations": [
        {
            "edgeWorkerId": 42,
            "version": 2,
            "activationId": 3,
            "accountId": "B-M-1KQK3WU",
            "status": "PENDING",
            "network": "PRODUCTION",
            "createdBy": "jdoe",
            "createdTime": "2018-07-09T09:03:28Z",
            "lastModifiedTime": "2018-07-09T09:04:42Z"
        },
        {
            "edgeWorkerId": 42,
            "version": 1,
            "activationId": 1,
            "accountId": "B-M-1KQK3WU",
            "status": "IN_PROGRESS",
            "network": "STAGING",
            "createdBy": "jsmith",
            "createdTime": "2018-07-09T08:13:54Z",
            "lastModifiedTime": "2018-07-09T08:35:02Z"
        },
        {
            "edgeWorkerId": 42,
            "version": 2,
            "activationId": 2,
            "accountId": "B-M-1KQK3WU",
            "status": "COMPLETE",
            "network": "PRODUCTION",
            "createdBy": "asmith",
            "createdTime": "2018-07-10T14:23:42Z",
            "lastModifiedTime": "2018-07-10T14:53:25Z"
        }
    ]
}
  1. Run the List EdgeWorker IDs operation and select an edgeWorkerId from the EdgeWorker members response object.

  2. Run the List versions operation and select a version from the Version members response object.

  3. Make a GET request to /edgeworkers/v1/ids/{edgeWorkerId}/activations{?version}.

  4. View the response body for details on the Activation.

Activate an EdgeWorker version

Activate an existing EdgeWorker version on the Akamai network, either staging or production.

POST /edgeworkers/v1/ids/{edgeWorkerId}/activations

Sample: /edgeworkers/v1/ids/42/activations

Content-Type: application/json

Object type: Activation

Download schema: activations-post-request.json

Request body:

{
    "network": "PRODUCTION",
    "version": 2
}
Parameter Type Sample Description
URL path parameters
edgeWorkerId Integer 42 Unique identifier for an EdgeWorker.

Status 201 application/json

Headers:

Location: https://akzz-XXXXXXXXXXXXXXXX-XXXXXXXXXXXXXXXX.luna.akamaiapis.net/edgeworkers/v1/edgeworkers/42/activations/3

Object type: Activation

Download schema: activation.json

Response body:

{
    "edgeWorkerId": 42,
    "version": 5,
    "activationId": 3,
    "accountId": "B-M-1KQK3WU",
    "status": "PRESUBMIT",
    "network": "PRODUCTION",
    "createdBy": "jsmith",
    "createdTime": "2019-04-05T18:17:46Z",
    "lastModifiedTime": "2019-04-05T18:17:46Z"
}
  1. Run the List EdgeWorker IDs operation and select an edgeWorkerId from the EdgeWorker members response object.

  2. Build a JSON request object specifying the version you want to activate and the network on which to activate the EdgeWorker.

  3. POST the object to /edgeworkers/v1/ids/{edgeWorkerId}/activations.

  4. Optionally store the Location response header, which tells you where to GET the new activation from.

  5. View the response body for details on the Activation.

Get an activation

View details for a specific activation.

GET /edgeworkers/v1/ids/{edgeWorkerId}/activations/{activationId}

Sample: /edgeworkers/v1/ids/42/activations/3

Parameter Type Sample Description
URL path parameters
edgeWorkerId Integer 42 Unique identifier for an EdgeWorker.
activationId String 3 Unique identifier for an EdgeWorker activation.

Status 200 application/json

Object type: Activation

Download schema: activation.json

Response body:

{
    "edgeWorkerId": 42,
    "version": 9,
    "activationId": 3,
    "accountId": "B-M-1KQK3WU",
    "status": "PENDING",
    "network": "PRODUCTION",
    "createdBy": "jsmith",
    "createdTime": "2018-08-04T11:42:56Z",
    "lastModifiedTime": "2018-08-04T12:00:03Z"
}
  1. Run the List EdgeWorker IDs operation and select an edgeWorkerId from the EdgeWorker members response object.

  2. Run the List activations operation and select an activationId from the Activation members response object.

  3. Make a GET request to /edgeworkers/v1/ids/{edgeWorkerId}/activations/{activationId}.

Data

This section details each type of data object that the API exchanges.

Download the JSON schemas for this API.

The data schema tables below list membership requirements as follows:

Member is required in requests, or always present in responses, even if its value is empty or null.
Member is optional, and may be omitted in some cases.
Member is out of scope, and irrelevant to the specified interaction context. If you include the member in that context, it either triggers an error, or is ignored.

Permissions

This section describes EdgeWorker capabilities allowed within the Akamai group.

Download schema: group.json

Sample GET response:

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

Permissions members

Member Type Description
Permissions: This section describes EdgeWorker capabilities allowed within the Akamai group.
capabilities Array List of EdgeWorker capabilities allowed within the group, including VIEW, EDIT, VIEW_VERSION, CREATE_VERSION, VIEW_ACTIVATION, and ACTIVATE.
groupId Number Unique identifier of the Akamai group specified when the EdgeWorker was created.
groupName String Name of the Akamai group specified when the EdgeWorker was created.

EdgeWorker

Attributes of an EdgeWorker.

Download schema: id-put-request.json, id.json

Sample POST request:

{
    "groupId": 72297,
    "name": "Ew_42"
}

EdgeWorker members

Member Type POST PUT Description
EdgeWorker: Attributes of an EdgeWorker.
accountId String Read-only. Identifier for the account within which the EdgeWorker was created.
createdBy String Read-only. Username of the person who created the EdgeWorker.
createdTime String Read-only. Timestamp, formatted as ISO 8601, indicating when the EdgeWorker was created.
edgeWorkerId Number Read-only. Unique identifier of the EdgeWorker.
groupId Number Unique identifier of the Akamai group specified when the EdgeWorker was created.
lastModifiedBy String Read-only. Username of the person who most recently updated the EdgeWorker.
lastModifiedTime String Read-only. Timestamp, formatted as ISO 8601, indicating when the EdgeWorker was most recently modified.
name String Name associated with the EdgeWorker.

Version

Provides details for an EdgeWorker version.

Download schema: version.json

Sample POST request:

{
    "edgeWorkerId": 42,
    "version": 5,
    "accountId": "B-M-1KQK3WU",
    "checksum": "de9f2c7fd25e1b3afad3e85a0bd17d9b100db4b3",
    "createdBy": "jsmith",
    "createdTime": "2018-07-05T18:17:46Z"
}

Version members

Member Type Required Description
Version: Provides details for an EdgeWorker version.
accountId String Read-only. Identifier for the account where the EdgeWorker was created.
checksum String Read-only. A SHA–256 hash digest of the tarball.
createdBy String Read-only. Username of the person who created the EdgeWorker version.
createdTime String Read-only. Timestamp, formatted as ISO 8601, indicating when the EdgeWorker version was created.
edgeWorkerId Number Read-only. Unique identifier of the EdgeWorker.
sequenceNumber String Read-only. An incrementing number indicating the upload order of the EdgeWorker versions.
version String Read-only. Unique identifier of the EdgeWorker version.

Activation

Information required to create an EdgeWorker activation.

Download schema: activations-post-request.json, activation.json

Sample POST request:

{
    "network": "PRODUCTION",
    "version": 2
}

Sample GET response:

{
    "edgeWorkerId": 42,
    "version": 9,
    "activationId": 3,
    "accountId": "B-M-1KQK3WU",
    "status": "PENDING",
    "network": "PRODUCTION",
    "createdBy": "jsmith",
    "createdTime": "2018-08-04T11:42:56Z",
    "lastModifiedTime": "2018-08-04T12:00:03Z"
}

Activation members

Member Type Required Description
Activation: Information required to create an EdgeWorker activation.
accountId String Read-only. Identifier for the account within which the EdgeWorker was created.
activationId Number Read-only. Unique identifier of the activation.
createdBy String Read-only. Username of the person who created the EdgeWorker.
createdTime String Read-only. Timestamp, formatted as ISO 8601, indicating when the EdgeWorker was created.
edgeWorkerId Number Read-only. Unique identifier of the EdgeWorker.
lastModifiedTime String Read-only. Timestamp, formatted as ISO 8601, indicating when the EdgeWorker was most recently modified.
network Enumeration The network on which the version is activated, either PRODUCTION or STAGING.
status Enumeration Read-only. The activation status of the EdgeWorker version, either PRESUBMIT, PENDING, IN_PROGRESS, COMPLETE, ABORTED, ERROR, DELETED_BY_AKAMAI, or EXPIRED.
version String Unique identifier of the version that will be activated.

Errors

This section details the API’s common responses to error cases. You’ll find the API’s range of response status codes for both error and success cases.

Error responses

This API adheres to the Problem Details for HTTP APIs standard, and returns detailed error responses, such as:

{
    "type": "/edgeworkers/error-types/edgeworkers-invalid-argument",
    "title": "Invalid Argument.",
    "detail": "Invalid tarball provided",
    "instance": "/devpops-api/error-instances/1fb2b105-e976-4e28-ba26-fa649a0d86ff",
    "status": 400
}

HTTP status codes

This section lists the full range of response codes the API may generate.

Code Description
200 The operation was successful.
201 The resource was created successfully.
400 Invalid or missing required parameters.
401 Invalid authorization credentials.
403 The client is not authorized to invoke the service. See Get started for information on API authorization.
404 Couldn’t find the requested resource.
422 System limit reached. See Resource Limiting.
500 Can’t return requested resource. May be corrupted.
502 Gateway unavailable to process request.
503 Service is temporarily unavailable.

Last modified: 10/3/2019