Akamai

Akamai: EdgeWorkers API

Akamai: EdgeWorkers API endpoints from Akamai

Developer tools#openapi

Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.

Overview

Akamai: EdgeWorkers API endpoints from Akamai

Endpoints 40

Contracts

  • GETList contract IDs/contracts?accountSwitchKey={{accountSwitchKey}}View the list of contract IDs that you can use to list resource tiers.

Permission groups

  • GETList permission groups/groups?accountSwitchKey={{accountSwitchKey}}View a list of groups and the associated permission capabilities, for example: activate a version or fetch an EdgeWorker ID.
  • GETGet a permission group/groups/:groupId?accountSwitchKey={{accountSwitchKey}}View details on the capabilities enabled within a specified group, for example: activate a version or fetch an EdgeWorker ID.

EdgeWorker IDs

  • GETList EdgeWorker IDs/ids?groupId={{groupId}}&resourceTierId={{resourceTierId}}&accountSwitchKey={{accountSwitchKey}}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.
  • POSTCreate a new EdgeWorker ID/ids?accountSwitchKey={{accountSwitchKey}}Register a new EdgeWorker within a particular group.
  • GETGet an EdgeWorker ID/ids/:edgeWorkerId?accountSwitchKey={{accountSwitchKey}}View details for a specific EdgeWorker.
  • PUTUpdate an EdgeWorker ID/ids/:edgeWorkerId?accountSwitchKey={{accountSwitchKey}}Update the name or groupId of an existing EdgeWorker.
  • DELETEDelete an EdgeWorker ID/ids/:edgeWorkerId?accountSwitchKey={{accountSwitchKey}}Delete a specific EdgeWorker ID.
  • POSTClone an EdgeWorker ID/ids/:edgeWorkerId/clone?accountSwitchKey={{accountSwitchKey}}Clone an EdgeWorker ID to change the resource tier.
  • GETGet the resource tier/ids/:edgeWorkerId/resource-tier?accountSwitchKey={{accountSwitchKey}}View the details of the resource tier assigned to the EdgeWorker ID.

Activations

  • GETList activations/ids/:edgeWorkerId/activations?version={{version}}&activeOnNetwork={{activeOnNetwork}}&network={{network}}&accountSwitchKey={{accountSwitchKey}}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…
  • POSTActivate an EdgeWorker version/ids/:edgeWorkerId/activations?accountSwitchKey={{accountSwitchKey}}Activate an existing EdgeWorker version on the Akamai network, either staging or production.
  • POSTRoll back to the previous active EdgeWorker version/ids/:edgeWorkerId/activations/rollback?accountSwitchKey={{accountSwitchKey}}Reactivate the EdgeWorker version that was previously active on the Akamai network, either staging or production.
  • GETGet an activation/ids/:edgeWorkerId/activations/:activationId?accountSwitchKey={{accountSwitchKey}}View details for a specific activation.
  • DELETECancel an activation/ids/:edgeWorkerId/activations/:activationId?accountSwitchKey={{accountSwitchKey}}Cancel a pending activation. You can cancel any activation whose status is still PENDING. After that you need to wait for the activation to complete and then…

Deactivations

  • GETList deactivations/ids/:edgeWorkerId/deactivations?version={{version}}&accountSwitchKey={{accountSwitchKey}}View the list of deactivations for an existing EdgeWorker. You can limit the results to a specific version.
  • POSTDeactivate an EdgeWorker version/ids/:edgeWorkerId/deactivations?accountSwitchKey={{accountSwitchKey}}Deactivate an existing EdgeWorker version on the Akamai network, either staging or production.
  • GETGet a deactivation/ids/:edgeWorkerId/deactivations/:deactivationId?accountSwitchKey={{accountSwitchKey}}View details for a specific deactivation.

Properties

  • GETList properties/ids/:edgeWorkerId/properties?activeOnly={{activeOnly}}&accountSwitchKey={{accountSwitchKey}}View the list of properties using an existing EdgeWorker ID. You can limit the results to active properties.

Revisions

  • GETList revisions/ids/:edgeWorkerId/revisions?version={{version}}&activationId={{activationId}}&network={{network}}&pinnedOnly={{pinnedOnly}}&currentlyPinned={{currentlyPinned}}&accountSwitchKey={{accountSwitchKey}}__Beta__ 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…
  • GETList revision activations/ids/:edgeWorkerId/revisions/activations?version={{version}}&activationId={{activationId}}&network={{network}}&accountSwitchKey={{accountSwitchKey}}__Beta__ List activations for an existing EdgeWorker revision based on the EdgeWorker's ID. To learn more about Flexible composition refer to the EdgeWorkers…
  • POSTActivate a fallback revision/ids/:edgeWorkerId/revisions/activations?accountSwitchKey={{accountSwitchKey}}__Beta__ Reactivate a previously active revision on Akamai's staging or production network. To learn more about Flexible composition refer to the EdgeWorkers…
  • GETGet a revision/ids/:edgeWorkerId/revisions/:revisionId?accountSwitchKey={{accountSwitchKey}}__Beta__ View details for a specific revision. To learn more about Flexible composition refer to the EdgeWorkers guide.
  • GETGet a revision BOM/ids/:edgeWorkerId/revisions/:revisionId/bom?includeActiveVersions={{includeActiveVersions}}&includePinnedRevisions={{includePinnedRevisions}}&accountSwitchKey={{accountSwitchKey}}__Beta__ View the Bill of Materials for a specific revision. To learn more about Flexible composition refer to the EdgeWorkers guide.
  • POSTCompare revisions/ids/:edgeWorkerId/revisions/:revisionId/compare?accountSwitchKey={{accountSwitchKey}}__Beta__ View dependency differences between two revisions of the same EdgeWorker activation. To learn more about Flexible composition refer to the…
  • GETDownload the combined code bundle/ids/:edgeWorkerId/revisions/:revisionId/content?accountSwitchKey={{accountSwitchKey}}__Beta__ Download the combined code bundle that contains the code and the dependencies that the EdgeWorker executes. To learn more about Flexible composition…
  • POSTPin an active revision/ids/:edgeWorkerId/revisions/:revisionId/pin?accountSwitchKey={{accountSwitchKey}}__Beta__ Disable dynamic activation for an EdgeWorker revision on Akamai's staging or production network. To learn more about Flexible composition refer to…
  • POSTUnpin an active revision/ids/:edgeWorkerId/revisions/:revisionId/unpin?accountSwitchKey={{accountSwitchKey}}__Beta__ Enable dynamic activation for an EdgeWorker revision on Akamai's staging or production network. To learn more about Flexible composition refer to the…

Versions

  • GETList versions/ids/:edgeWorkerId/versions?accountSwitchKey={{accountSwitchKey}}View a list of EdgeWorker versions.
  • POSTCreate a new version/ids/:edgeWorkerId/versions?accountSwitchKey={{accountSwitchKey}}Create a new version of an EdgeWorker. In order to run this operation you need to build an EdgeWorkers code bundle and save it in GZIP format. You need to…
  • GETGet version details/ids/:edgeWorkerId/versions/:version?accountSwitchKey={{accountSwitchKey}}View details for a specific version.
  • DELETEDelete version/ids/:edgeWorkerId/versions/:version?accountSwitchKey={{accountSwitchKey}}Delete a specific version.
  • GETDownload an EdgeWorkers code bundle/ids/:edgeWorkerId/versions/:version/content?accountSwitchKey={{accountSwitchKey}}Download the bundle containing the code the EdgeWorker executes.

Limits

  • GETList limits/limits?accountSwitchKey={{accountSwitchKey}}View the various limits EdgeWorkers imposes on the number of activations, EdgeWorkers IDs, and versions you can deploy.

Reports

  • GETList reports/reports?accountSwitchKey={{accountSwitchKey}}View a list of available reports. The data in these reports is also available in the EdgeWorkers Management application.
  • GETGet an EdgeWorker report/reports/:reportId?start={{start}}&end={{end}}&edgeWorker={{edgeWorker}}&status={{status}}&eventHandler={{eventHandler}}&accountSwitchKey={{accountSwitchKey}}View details for a specific EdgeWorker.

Resource tiers

  • GETList resource tiers/resource-tiers?contractId={{contractId}}&accountSwitchKey={{accountSwitchKey}}View the list of available resource tiers for a specific contract ID. The resource tier defines the resource consumption limits for an EdgeWorker ID.

Secure tokens

  • POSTCreate a secure token/secure-token?accountSwitchKey={{accountSwitchKey}}Generate a JWT authentication token to enable enhanced debug headers for EdgeWorkers.
  • GETGet a secure token/secure-token/:propertyId?acl={{acl}}&url={{url}}&expiry={{expiry}}&network={{network}}&accountSwitchKey={{accountSwitchKey}}__Deprecated__ Use the Create a secure token operation instead. This returns a generated authentication token, for use with enhanced debug headers for…

Validations

  • POSTValidate an EdgeWorkers code bundle/validations?accountSwitchKey={{accountSwitchKey}}Return a list of errors and warnings containing details on how to fix your code bundle. See Validation types. In order to run this operation you need to…

API details

Base URL
https://{hostname}/edgeworkers/v1
Authentication
None declared in the description
Operations
40 operations on 31 pathsGET 24POST 12DELETE 3PUT 1
Main resources
Revisions 9EdgeWorker IDs 7Activations 5Versions 5Deactivations 3Permission groups 2Reports 2Secure tokens 2Contracts 1Limits 1
Response formats
application/json */* application/gzip application/problem+json
Description format
OpenAPI 3.0.0, API version v1

How to test the Akamai: EdgeWorkers API in Swastik Codes

  1. Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
  2. Fork it into your workspaceChoose a workspace. You get your own copy of the Akamai: EdgeWorkers API collection, without the publisher's secrets.
  3. Add your credentialsOpen the collection's variables or an environment and enter your API key or token, if the API needs one.
  4. Send a requestPick an endpoint, for example “List contract IDs” (GET /contracts?accountSwitchKey={{accountSwitchKey}}), and press Send. Check the response, add tests and run the whole collection with the runner.

Frequently asked questions

What is the Akamai: EdgeWorkers API?

Akamai: EdgeWorkers API endpoints from Akamai It is listed under Developer tools and has 40 endpoints.

Who publishes the Akamai: EdgeWorkers API?

It is listed from Akamai's public API description (an OpenAPI document), not published by Akamai on Swastik Codes. Anyone who controls akamai.com can claim the profile by adding a DNS TXT record.

What is the base URL of the Akamai: EdgeWorkers API?

Requests go to https://{hostname}/edgeworkers/v1. Endpoint paths are added to this base URL.

How do I authenticate with the Akamai: EdgeWorkers API?

Its OpenAPI description does not declare an authentication scheme. Some endpoints may be open; check the provider's documentation before relying on that.

How many endpoints does the Akamai: EdgeWorkers API have?

40 operations on 31 paths (24 GET, 12 POST, 3 DELETE, 1 PUT). The largest groups are Revisions, EdgeWorker IDs, Activations, Versions.

Is forking the Akamai: EdgeWorkers API free?

Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.

Suggest an API

Tell us which public API is missing. We check it, then add it here with its endpoints when it has an OpenAPI (Swagger) description.