EdgeWorkers CLI The EdgeWorkers command line interface (CLI) expedites the process of registering, uploading, activating and testing EdgeWorkers functions on the Akamai Edge network.
Go to Akamai CLI for EdgeKV for information on how to manage EdgeKV databases and call the EdgeKV API from the command line.
To use this tool you need:
Akamai CLI installed.
If you do not have the CLI and are using Homebrew on a Mac, run this
command: brew install akamai
You may also download OS-specific CLI binaries or a Docker image
Valid EdgeGrid credentials configured via Akamai Control Center ( see Get Started with APIs)
Node version 14 or higher
If you do not have the EdgeWorkers CLI package installed, use the following Akamai CLI command to install the latest EdgeWorkers CLI package:
Usage:akamai install edgeworkers
If you already have the CLI installed, use the following Akamai CLI command to install the latest EdgeWorkers CLI package that includes EdgeKV functionality:
Usage:akamai update edgeworkers
The EdgeWorkers CLI lets you set default values for the command options. There are two ways to create a config file:
Create a config file ~/.akamai-cli/ew-config, and store the properties as follows:
[default] edgeworkerName=testEW groupId=12345 versionId=1-0-2
Use the config command to set default properties:akamai edgeworkers config set
Available property names are displayed here.
EdgeWorkers CLI enables you to manage EdgeWorkers functions by calling the EdgeWorkers API.
Conventions:
optional args []
required args <>
Usage:akamai edgeworkers [options] [command]
Options:
| Syntax | Description |
|---|---|
| -V, --version | Display the version number for the EdgeWorkers CLI program. |
| --debug | Show debug information. |
--edgerc | Use credentials in edgerc file for command. (Default file location is ~/.edgerc) |
--section | Use this section in edgerc file. (Default section is [default]) |
--configSection | Use this section in the ew-config file that contains the default config properties set. (Default section is [default]) |
--timeout | You can specify a timeout value for a command in seconds to override the 2 minute default. For example, if you add "--timeout 10" to a command, it will timeout if the server takes more than 10 second to respond. |
--json [path] | Write CLI output as JSON to optionally provided path. If not path provided, write JSON output to CLI home directory |
| --jsonout | Write CLI output as JSON to stdout. |
| -h, --help | Display usage information for EdgeWorkers CLI. |
Commands:
| Command | Alias | Description |
|---|---|
help [command] | Display usage information for the given command. |
list-groups | lg [group-identifier] | Customer Developer can find their EdgeWorkers access level per Luna Access Control Group. |
list-ids | li [options] [edgeworker-identifier] | List EdgeWorker ids currently registered. |
register | create-id | Register a new EdgeWorker id to reference in Property Manager behavior. |
update-id | ui | Allows Customer Developer to update an existing EdgeWorker Identifier's Luna ACG or Name attributes. |
delete-id | delete-id [options] | Permanently delete an existing EdgeWorker Id. |
list-versions | lv | List Version information of a given EdgeWorker Id. |
upload | create-version [options] | Creates a new version of a given EdgeWorker Id which includes the code bundle. |
delete-version | delete-version [options] | Permanently delete an existing version of a given EdgeWorker Id. |
download | download-version [options] | Download the code bundle of an EdgeWorker version. |
download-revision | dr [options] | Download the combined code bundle that contains the code and the dependencies that the EdgeWorker executes. |
status | list-activations [options] | List Activation status of a given EdgeWorker Id. |
list-revisions | lr [options] | List the revision history for a given EdgeWorker ID. |
get-revision | gr | Get details for a specific revision. |
compare-revisions | cr | View dependency differences between two revisions of the same EdgeWorker. |
activate-revision | ar [options] | Activate a revision for a given EdgeWorker Id on Akamai Network. |
pin-revision [options] | Pin an active revision for a given EdgeWorker ID. |
unpin-revision [options] | Unpin an active pinned revision for a given EdgeWorker ID. |
get-revision-bom | gb [options] | View details for a specific revision of a composite bundle. |
list-revision-activations | lra [options] | List Revision Activation status of a given EdgeWorker ID. |
activate | av | Activate a Version for a given EdgeWorker Id on an Akamai Network. |
deactivate | deact | Deactivate a Version for a given EdgeWorker Id on an Akamai Network. |
validate | vv | Validates a code bundle version without uploading the code bundle. |
create-auth-token | auth [options] | Generates an authentication token that can be used to get detailed EdgeWorker debug response headers. You need at least version 1.7.1 of the EdgeWorkers CLI to run this command. |
clone | clone | Clones an EdgeWorker from the existing EdgeWorker Id. |
list-contracts | li-contracts [options] | List of contract ids that user has access to. |
list-properties | lp | List of properties associated with a given EdgeWorker Id. |
| list-limits | li-limits | View the various limits EdgeWorkers imposes on the number of activations, EdgeWorkers IDs, and versions you can deploy. |
list-restiers | li-restiers [options] | List Resource Tiers that can be used to create or clone EdgeWorker Id. |
show-restier | show-restier | Customers can get Resource Tier details for a specific EdgeWorker Id. |
| get reports | Get a list of all available EdgeWorkers reports. |
get report | Get an EdgeWorkers report for a specific EdgeWorker ID. |
| config list | Get all values in the config file. |
config get | Get a config value from a section in the config file. |
config set | Set a config value in a section. |
config save -p | Save config properties in a section. |
config unset | Unset a config value in a section. |
Customer Developer can find their EdgeWorkers access level per Luna Access Control Group.
Usage: akamai edgeworkers list-groups [options] [group-identifier]
| Option | Description |
|---|---|
| -h, --help | output usage information |
| Argument | Existence | Description |
|---|---|---|
| group-identifier | optional | Luna Access Group value (usually number) to check for EdgeWorkers permissions |
Output is filtered to only those Luna Access Control Groups that have at least one EdgeWorkers capability.
Capabilities can be: VIEW,VIEW_VERSION,EDIT,VIEW_ACTIVATION,CREATE_VERSION,ACTIVATE
List EdgeWorker ids currently registered.
Usage: akamai edgeworkers list-ids [options] [edgeworker-identifier]
| Option | Description |
|---|---|
| -h, --help | output usage information |
--groupId | Filter EdgeWorker Id list by Permission Group |
--resourceTierId | Filter EdgeWorker Id by Resource Tier |
| Argument | Existence | Description |
|---|---|---|
| edgeworker-identifier | optional | A unique integer handle to an EdgeWorkers instance |
Register a new EdgeWorker id to reference in Property Manager behavior.
Usage: akamai edgeworkers register [options]
| Option | Description |
|---|---|
| --resourceTierId | New Resource tier id to which the EdgeWorker will be associated. |
| -h, --help | output usage information |
| Argument | Existence | Description |
|---|---|---|
| group-identifier | required | Luna Access Group value (usually number) to check for EdgeWorkers permissions |
| edgeworker-name | required | Human readable short label describing an EdgeWorkers instance |
Location response header will be provided with new EdgeWorker Id.
EdgeWorker id details response body (JSON) will be provided with 201 response code.
To disable prompts for automation purpose "resourceTierId" can be provided as input.
Allows Customer Developer to update an existing EdgeWorker Identifier's Luna ACG or Name attributes.
Usage: akamai edgeworkers update-id [options]
| Option | Description |
|---|---|
| --resourceTierId | New Resource tier id to which the EdgeWorker will be associated |
| -h, --help | output usage information |
| Argument | Existence | Description |
|---|---|---|
| edgeworker-identifier | required | A unique integer handle to an EdgeWorkers instance |
| group-identifier | required | Luna Access Group value (usually number) to check for EdgeWorkers permissions |
| edgeworker-name | required | Human readable short label describing an EdgeWorkers instance |
API requires that both groupId and name be provided even if only changing one of these attributes.
EdgeWorker id details response body (JSON) will be provided with 200 response code.
Resource Tier ID provided should be same as the one the EdgeWorker ID already has. In order to provide a different resource tier id, please use the clone operation.
Permanently delete an existing EdgeWorker Identifier.
Usage: akamai edgeworkers delete-id [options]
| Option | Description |
|---|---|
| -h, --help | output usage information |
| --noPrompt | Skip the deletion confirmation prompt |
| Argument | Existence | Description |
|---|---|---|
| edgeworker-identifier | required | A unique integer handle to an EdgeWorkers instance |
Deleting an EdgeWorker ID is only possible if it doesn't have any version currently active or being activated on the Akamai network.
Ensure that there are no active properties associated with an EdgeWorker before deletion.
List Version information of a given EdgeWorker Id.
Usage: akamai edgeworkers list-versions [options]
| Option | Description |
|---|---|
| -h, --help | output usage information |
| Argument | Existence | Description |
|---|---|---|
| edgeworker-identifier | required | A unique integer handle to an EdgeWorkers instance |
| version-identifier | optional | A unique integer handle to version of an EdgeWorkers instance |
Result set is sorted by an upload sequence value that is not displayed (an internal incremented integer).
EdgeWorker versions are customer defined strings.
Creates a new version of a given EdgeWorker Id which includes the code bundle.
Usage: akamai edgeworkers upload [options]
| Option | Description |
|---|---|
| -h, --help | output usage information |
--bundle | Path to bundle file in tgz format |
--codeDir | Working directory that includes main.js and bundle.json files |
| Argument | Existence | Description |
|---|---|---|
| edgeworker-identifier | required | A unique integer handle to an EdgeWorkers instance |
One of either --bundle or --codeDir (but not both) must be provided.
Code bundles paths and files must be found on the local filesystem.
--bundle expects a tgz file already built per EdgeWorkers specification.
--codeDir expects a directory path which contains both the main.js (events file) and bundle.json (manifest file).
--codeDir option will provide bundle.json format validation.
--codeDir does not pack other directories or code beyond main.js and bundle.json.
--codeDir will build the tarball (tgz) file if file validation succeeds.
Service will compare new tarball's checksum with previously uploaded tarballs for the same EdgeWorker id (ewId). If
a match is found, the new version creation is disallowed.
versionId is customer generated and will be pulled from bundle.json.
Location response header will be provided with new EdgeWorker Version id.
EdgeWorker version details response body (JSON) will be provided with 201 response code.
Permanently delete an existing version of a given EdgeWorker Id.
Usage: akamai edgeworkers delete-version [options]
| Option | Description |
|---|---|
| -h, --help | output usage information |
| --noPrompt | Skip the deletion confirmation prompt |
| Argument | Existence | Description |
|---|---|---|
| edgeworker-identifier | required | A unique integer handle to an EdgeWorkers instance |
| version-identifier | required | A unique integer handle to version of an EdgeWorkers instance |
Deleting a version is only possible if it is not currently active or being activated on the Akamai network.
If the version is currently active, it will have to be deactivated before it can be deleted.
Download the code bundle of an EdgeWorker version.
Usage: akamai edgeworkers download [options]
| Option | Description |
|---|---|
| -h, --help | output usage information |
--downloadPath | Path to store downloaded bundle file; defaults to CLI home directory if not provided. |
| Argument | Existence | Description |
|---|---|---|
| edgeworker-identifier | required | A unique integer handle to an EdgeWorkers instance |
| version-identifier | required | A unique integer handle to version of an EdgeWorkers instance |
If --downloadPath is not provided or is not found on local filesystem, an AkamaiCLI cache sub-directory will be
used:
Download the combined code bundle that contains the code and the dependencies that the EdgeWorker executes.
Usage: akamai edgeworkers download-revision [options]
| Option | Description |
|---|---|
| -h, --help | output usage information |
--downloadPath | Path to store downloaded combined bundle file; defaults to CLI home directory if not provided. |
| Argument | Existence | Description |
|---|---|---|
| edgeworker-identifier | required | A unique integer handle to an EdgeWorkers instance |
| revision-identifier | required | A unique revision identifier to a specific of an EdgeWorkers instance |
If --downloadPath is not provided or is not found on local filesystem, an AkamaiCLI cache sub-directory will be
used:
List Activation status of a given EdgeWorker Id.
Usage: akamai edgeworkers status [options]
| Option | Description |
|---|---|
| -h, --help | output usage information |
--versionId | Version identifier |
--activationId | Activation identifier |
| --activeOnNetwork | Limits results to show only currently activate versions |
--network | Limits the results to versions that were activated on a specific network (STAGING or PRODUCTION) |
| Argument | Existence | Description |
|---|---|---|
| edgeworker-identifier | required | A unique integer handle to an EdgeWorkers instance |
You may not provide both the Version and the Activation identifiers.
List the revision history for a given EdgeWorker ID.
Usage: akamai edgeworkers list-revisions [options]
| Option | Description |
|---|---|
| -h, --help | output usage information |
--versionId | Version identifier |
--activationId | Activation identifier |
| --pinnedOnly | Limits results to show only currently or previously pinned revisions |
| --currentlyPinned | Limits results to show only revisions that are currently pinned |
--network | Limits the results to versions that were activated on a specific network (STAGING or PRODUCTION) |
| Argument | Existence | Description |
|---|---|---|
| edgeworker-identifier | required | A unique integer handle to an EdgeWorkers instance |
Network must be either STAGING or PRODUCTION. Capitalization will be normalized to uppercase.
Get details for a specific revision.
Usage: akamai edgeworkers get-revision [options]
| Option | Description |
|---|---|
| -h, --help | output usage information |
| Argument | Existence | Description |
|---|---|---|
| edgeworker-identifier | required | A unique integer handle to an EdgeWorkers instance |
| revision-identifier | required | Revision identifier |
View dependency differences between two revisions of the same EdgeWorker.
Usage: akamai edgeworkers compare-revisions [options]
| Option | Description |
|---|---|
| -h, --help | output usage information |
| Argument | Existence | Description |
|---|---|---|
| edgeworker-identifier | required | A unique integer handle to an EdgeWorkers instance |
| revision-identifier | required | First Revision identifier |
| revision-identifier | required | Second Revision identifier |
Both the revision identifiers must be different.
Activate a revision for a given EdgeWorker ID on an Akamai Network.
Usage: akamai edgeworkers activate-revision [options]
| Option | Description |
|---|---|
| -h, --help | output usage information |
| --note | Note to specify why the revision is being reactivated |
| Argument | Existence | Description |
|---|---|---|
| edgeworker-identifier | required | A unique integer handle to an EdgeWorkers instance |
| revision-identifier | required | Revision identifier |
The revision will be reactivated on the same network (PRODUCTION or STAGING) that it was previously active on.
Pin an active revision for a given EdgeWorker ID.
Usage: akamai edgeworkers pin-revision [options]
| Option | Description |
|---|---|
| -h, --help | output usage information |
| --note | Note to specify why the revision is being pinned |
| Argument | Existence | Description |
|---|---|---|
| edgeworker-identifier | required | A unique integer handle to an EdgeWorkers instance |
| revision-identifier | required | Revision identifier |
The revision must be activated before pinning.
Unpin an active pinned revision for a given EdgeWorker ID.
Usage: akamai edgeworkers unpin-revision [options]
| Option | Description |
|---|---|
| -h, --help | output usage information |
| --note | Note to specify why the revision is being unpinned |
| Argument | Existence | Description |
|---|---|---|
| edgeworker-identifier | required | A unique integer handle to an EdgeWorkers instance |
| revision-identifier | required | Revision identifier |
The revision must be pinned before unpinning.
View details for a specific revision of a composite bundle.
Usage: akamai edgeworkers get-revision-bom [options]
| Option | Description |
|---|---|
| -h, --help | output usage information |
| --activeVersions | Limit results to show only active versions |
| --currentlyPinnedRevisions | Shows additional information about the revision that's currently pinned |
| Argument | Existence | Description |
|---|---|---|
| edgeworker-identifier | required | A unique integer handle to an EdgeWorkers instance |
| revision-identifier | required | Revision identifier |
List Revision Activation status of a given EdgeWorker ID.
Usage: akamai edgeworkers list-revision-activations [options]
| Option | Description |
|---|---|
| -h, --help | output usage information |
| --versionId | Version Identifier |
| --activationId | Activation Identifier |
| --network | Limits the results to versions that were activated on a specific network (STAGING or PRODUCTION) |
| Argument | Existence | Description |
|---|---|---|
| edgeworker-identifier | required | A unique integer handle to an EdgeWorkers instance |
You may not provide both the Version and the Activation identifiers.
Network must be either STAGING or PRODUCTION. Capitalization will be normalized to uppercase.
Activate a Version for a given EdgeWorker Id on an Akamai Network.
Usage: akamai edgeworkers activate [options]
| Option | Description |
|---|---|
| -h, --help | output usage information |
| Argument | Existence | Description |
|---|---|---|
| edgeworker-identifier | required | A unique integer handle to an EdgeWorkers instance |
| network | required | Label for which Akamai Network (STAGING or PRODUCTION) activation should be sent to |
| version-identifier | required | A unique integer handle to version of an EdgeWorkers instance |
Network must be either STAGING or PRODUCTION. Capitalization will be normalized to uppercase.
Location response header will be provided with new EdgeWorker Activation id.
EdgeWorker activation details response body (JSON) will be provided with 201 response code.
Validates a code bundle version without uploading the code bundle
Usage: akamai edgeworkers validate [options]
| Option | Description |
|---|---|
| -h, --help | output usage information |
| Argument | Existence | Description |
|---|---|---|
| bundlePath | required | Path to bundle file in tgz format |
Code bundle path must be found on the local filesystem.
Code bundle expects a tgz file already built per EdgeWorkers specification.
Deactivate a Version for a given EdgeWorker Id on an Akamai Network.
Usage: akamai edgeworkers deactivate [options]
| Option | Description |
|---|---|
| -h, --help | output usage information |
| Argument | Existence | Description |
|---|---|---|
| edgeworker-identifier | required | A unique integer handle to an EdgeWorkers instance |
| network | required | Label for which Akamai Network (STAGING or PRODUCTION) activation should be sent to |
| version-identifier | required | A unique integer handle to version of an EdgeWorkers instance |
Network must be either STAGING or PRODUCTION. Capitalization will be normalized to uppercase.
Location response header will be provided with new EdgeWorker Activation id.
EdgeWorker activation details response body (JSON) will be provided with 201 response code.
Generates an authentication token that can be used to get detailed EdgeWorker debug response headers. You need at least version 1.7.1 of the EdgeWorkers CLI to run this command. Use the -V, --version option to display the current version number of the EdgeWorkers CLI.
Usage: akamai edgeworkers create-auth-token [options]
| Option | Description |
|---|---|
| -h, --help | output usage information |
--expiry | Expiry duration of token, in minutes. |
--format | Format in which the output will be printed |
| Argument | Existence | Description |
|---|---|---|
| hostName | opional | HostName of the property. If no hostname is provided then token is created for all hosts(/*) under the property. Eg: www.test.com, www.test1.com |
The --expiry value must be between 1 and 720 minutes (12 hours). The default is 8 hours.
Allows customer to clone an EdgeWorker from an existing EdgeWorker Id.
Usage: akamai edgeworkers clone
| Option | Description |
|---|---|
| -h, --help | output usage information |
| --ewName | Name of the EdgeWorker |
| --groupId | Group identifier |
| Argument | Existence | Description |
|---|---|---|
| resourceTierId | required | Resource tier id to which the EdgeWorker will be cloned. |
This endpoint allows user to select a different Resource Tier ID for a specific EdgeWorker id by cloning it. Cloning to the same resource tier will fail.
List of contract ids that user has access to.
Usage: akamai list-contracts
| Option | Description |
|---|---|
| -h, --help | output usage information |
List of properties associated to a specific EdgeWorker Id.
Usage: akamai edgeworkers list-properties
| Option | Description |
|---|---|
| -h, --help | output usage information |
| --activeOnly | Returns only active properties |
| Argument | Existence | Description |
|---|---|---|
| edgeworker-identifier | required | EdgeWorker identifier. |
Note that the returned boolean limitedAccessToProperties is true if the user doesn't have access to the top level group under the account, or if they don't have the admin role for this group.
List the various limits EdgeWorkers imposes on the number of activations, EdgeWorkers IDs, and versions you can deploy.
Usage: akamai edgeworkers list-limits [options]
| Option | Description |
|---|---|
| -h, --help | output usage information |
List Resource Tiers that can be used to create or clone EdgeWorker IDs.
Usage: akamai list-restiers
| Option | Description |
|---|---|
| --contractId | Resource tiers for the specified contract id. |
| -h, --help | output usage information |
User will be prompted with list of contract ids that user has access to. The selected contract id will be used to fetch resource tier.
To disable prompt for automation purpose, contract id can be provided as input.
Customers can get Resource Tier details for a specific EdgeWorker Id.
Usage: akamai show-restier
| Option | Description |
|---|---|
| -h, --help | output usage information |
| Argument | Existence | Description |
|---|---|---|
| edgeworkerId | required | EdgeWorker identifier |
List the available report types that can be generated for an EdgeWorker ID.
Usage: akamai get reports
| Option | Description |
|---|---|
| -h, --help | output usage information |
The user will be given a table with reportIds and a description of each report. Use a given reportId with
the get report command to get a report for a given EdgeWorker.
Get a report for a given EdgeWorker ID.
Usage: akamai get report
| Option | Existence | Description |
|---|---|---|
| -h, --help | optional | output usage information |
-s, --startDate | required | ISO 8601 timestamp indicating the start time of the EdgeWorkers report. |
-e, --endDate | optional | ISO 8601 timestamp indicating the end time of the EdgeWorkers report. If not specified, the end time defaults to the current time. |
--status | optional | Comma-separated string to filter by EdgeWorkers status. Values: success, genericError, unknownEdgeWorkerId, unimplementedEventHandler, runtimeError, executionError, timeoutError, resourceLimitHit, cpuTimeoutError, wallTimeoutError, initCpuTimeoutError, initWallTimeoutError. |
--ev, --eventHandlers | optional | Comma-separated string to filter EdgeWorkers by the event that triggers them. Values: onClientRequest, onOriginRequest, onOriginResponse, onClientResponse, responseProvider. |
| Argument | Existence | Description |
|---|---|---|
| reportId | required | Report Type. |
| edgeworker-identifier | required | EdgeWorker identifier. |
For a list of available report IDs, use the get reports command.
The startDate option is a required option.
Get all default properties in a section of the config file.
Usage: akamai config list
| Option | Existence | Description |
|---|---|---|
| -h, --help | optional | output usage information |
The config section is default by default. To use a different seciont, users should specify the akamai edgeworkerscommand with option --configSection .
Same approach should apply to the following config commands.
Get one specific default value in a section of the config file.
Usage: akamai config get
| Option | Existence | Description |
|---|---|---|
| -h, --help | optional | output usage information |
| Argument | Existence | Description |
|---|---|---|
| key | required | Name of default property |
Allows customers set/update a specific default value in a section of the config file.
Usage: akamai config set
| Option | Existence | Description |
|---|---|---|
| -h, --help | optional | output usage information |
| Argument | Existence | Description |
|---|---|---|
| key | required | Name of default property |
| value | required | Value of default property |
Allows customers unset a specific default value in a section of the config file.
Usage: akamai config unset
| Option | Existence | Description |
|---|---|---|
| -h, --help | optional | output usage information |
| Argument | Existence | Description |
|---|---|---|
| key | required | Name of default property |
Allows customers save the default values in bulk.
Usage: akamai config save [options]
| Option | Existence | Description |
|---|---|---|
| -h, --help | optional | output usage information |
| -p, --properties | required | Config properties. Use format 'key=value' to set a property and white space to split them. |
If the context contain invalid item, the command will skip that item and continue.
Allows customers to view the details of logging level overrides for the edgeworker.
Usage: akamai edgeworkers log-level get [options]
| Option | Existence | Description |
|---|---|---|
| -h, --help | optional | output usage information |
| Argument | Existence | Description |
|---|---|---|
| edgeworker-identifier | required | EdgeWorker identifier for which to display logging level override information. |
| logging-identifier | optional | The logging ID of the logging level override to display. |
If the logging-identifier is not specified, all logging level overrides will be displayed.
The logging-identifier is a numeric constant, identifying a log level override. It can be obtained during the override creation, or by listing all overrides without supplying the optional argument and looking up specific override's loggingId field.
Allows customers to set logging level for the EdgeWorker.
Usage: akamai edgeworkers log-level set [options]
| Option | Existence | Description |
|---|---|---|
| -h, --help | optional | output usage information |
| --expires | optional | Specifies for how long the user's logging level override will be applied. After it has passed, the logging level reverts back to the default specified in the bundle. |
| --ds2Id | optional | Datastream ID to use alongside the one specified in EdgeWorker's bundle.json file. |
| Argument | Existence | Description |
|---|---|---|
| edgeworker-identifier | required | EdgeWorker identifier for which to change logging level. |
| network | required | Network for which to apply the new logging level. Either "production" or "staging". |
| level | required | New logging level to apply for the EdgeWorker. For possible values consult customer logging documentation. |
Only the most recently created log level override is in effect.
When the override expires, the logging level is reset to the one specified in Edgeworker's bundle.json file.
If the command is successful, the log level override details are printed, which include loggingId of the override. The loggingId can be used to obtain these details anytime by using log-level get subcommand and passing it to a logging-identifier optional argument.
If --expires option is not specified, the default is for the override to never expire.
The --expires option supports both natural language input and standard timestamps. Please refer to chrono package documentation for full specification.
Set log level override on production network to info level, which will expire in 1 hour.
./akamai-edgeworkers log-level set 654321 production info --expires 1h
Set log level override on staging network to trace level, which will expire at 3 PM CEST (Central European Summer Time) on August 13th 2024.
./akamai-edgeworkers log-level set 654321 staging trace --expires "2024-08-13T15:00+02:00"
For more information on EdgeWorkers, refer to the following resources:
EdgeWorkers Developer Page
EdgeWorkers User Guide
EdgeWorkers API Guide
You are all set, happy coding! If you experience any issues with the EdgeWorkers CLI, raise them as a github issue. Feel free to create a pull request with the fix or suggestion.
We welcome contributions from Akamai staff, customers, or others. Before opening up a PR please double check the following:
Please add some test cases to accompany your PR. This verifies the functionality added or modified in the PR and proves to others that your code works :)
Please make sure that your code passes all pre-commit checks. Your code should build successfully, pass all unit tests, and have no linting issues.
All PR's should be targeting develop, not master. Merges to master will immediately release to all customers.
