API

EdgeWorkers API
- EdgeKV API
API summary
OpenAPI schema
Get started
EdgeWorkers concepts
Rate and resource limiting
Errors
- Validation types
- 400
- 401
- 403
- 404
- 422
- 429
- 500
- 501
- 502
- 503

Groups

Permission groups
- List permission groupsget
- Get a permission groupget

Resource tiers

Resource tiers
- List resource tiersget

EdgeWorker IDs

EdgeWorker IDs
Versions
Activations
Deactivations
Properties
- List propertiesget
Revisions

Validations

Validations
- Validate an EdgeWorkers code bundlepost

Contracts

Contracts
- List contract IDsget

Reports

Reports
- List reportsget
- Get an EdgeWorker reportget

Secure Token

Secure tokens
- Create a secure tokenpost
- Get a secure tokenget

EdgeWorkers customer log delivery

Logging override
- Create a new logging overridepost
List logging overrides
- List logging overridesget
Get logging override status
- Get logging override statusget

Limits

Limits
- List limitsget

Deactivate an EdgeWorker version

post https://{hostname}/edgeworkers/v1/ids/{edgeWorkerId}/deactivations

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

Recipes

Open Recipe

Path Params

edgeWorkerId

integer

required

≥ 1

Unique identifier for an EdgeWorker.

Query Params

accountSwitchKey

string

For customers who manage more than one account, this runs the operation from another account. The Identity and Access Management API provides a list of available account switch keys.

Body Params

network

string

required

The network on which the version will be deactivated, either STAGING or PRODUCTION.

note

string

length between 1 and 128

Note to specify why the version is being deactivated.

version

string

required

length ≥ 1

Unique identifier of the version that will be deactivated.

Response

Response body

object

accountId

string

required

length ≥ 1

Identifier for the account under which the EdgeWorker was created.

createdBy

string

required

length ≥ 1

Username of the person who created the EdgeWorker.

createdTime

date-time

required

ISO 8601 timestamp indicating when the EdgeWorker was created.

deactivationId

integer

required

≥ 1

Unique identifier of the deactivation.

edgeWorkerId

integer

required

≥ 1

Unique identifier of the EdgeWorker.

lastModifiedTime

date-time

required

ISO 8601 timestamp indicating when the EdgeWorker was most recently modified.

network

string

required

The network on which the version is deactivated, either STAGING or PRODUCTION.

STAGING PRODUCTION

note

string

length between 1 and 128

Note to specify why the version is being deactivated.

status

string

required

The deactivation status of the EdgeWorker version, either PRESUBMIT, PENDING, IN_PROGRESS, COMPLETE, ABORTED, ERROR, DELETED_BY_AKAMAI, CANCELLING, CANCELLED, or EXPIRED.

PRESUBMIT PENDING IN_PROGRESS COMPLETE CANCELLING CANCELLED ABORTED ERROR DELETED_BY_AKAMAI EXPIRED

version

string

required

length ≥ 1

Unique identifier of the version.

Headers

object

Location

string

Use this URL to fetch the new resource.

Updated over 1 year ago

Cancel an activation

List deactivations

Language

Authentication

Remember to add your authentication credentials to run this code.

URL


xxxxxxxxxx
1
curl --request POST \
2
     --url https://hostname/edgeworkers/v1/ids/edgeWorkerId/deactivations \
3
     --header 'accept: application/json' \
4
     --header 'content-type: application/json' \
5
     --data '
6
{
7
  "network": "STAGING"
8
}
9
'

Click Try It! to start a request and see the response here! Or choose an example:

application/json

Updated over 1 year ago

Cancel an activation

List deactivations

🦉

Recipe Title

Recipe Description

{"success":true}

API
EdgeWorkers API
API summary
Get started
EdgeWorkers concepts
Rate and resource limiting
Errors
503
502
501
500
429
422
404
403
401
400
Validation types

Groups
Permission groups
Get a permission groupget
List permission groupsget

Resource tiers
Resource tiers
List resource tiersget

EdgeWorker IDs
EdgeWorker IDs
Get the resource tierget
Clone an EdgeWorker IDpost
Delete an EdgeWorker IDdelete
Update an EdgeWorker IDput
Get an EdgeWorker IDget
List EdgeWorker IDsget
Create a new EdgeWorker IDpost
Versions
Download an EdgeWorkers code bundleget
Delete versiondelete
Get version detailsget
List versionsget
Create a new versionpost
Activations
Cancel an activationdelete
Get an activationget
Roll back to the previous active EdgeWorker versionpost
List activationsget
Activate an EdgeWorker versionpost
Deactivations
Get a deactivationget
List deactivationsget
Deactivate an EdgeWorker versionpost
Properties
List propertiesget
Revisions
Unpin an active revisionpost
Pin an active revisionpost
Download the combined code bundleget
Compare revisionspost
Get a revision BOMget
Get a revisionget
List revision activationsget
Activate a fallback revisionpost
List revisionsget

Validations
Validations
Validate an EdgeWorkers code bundlepost

Contracts
Contracts
List contract IDsget

Reports
Reports
Get an EdgeWorker reportget
List reportsget

Secure Token
Secure tokens
Get a secure tokenget
Create a secure tokenpost

EdgeWorkers customer log delivery
Logging override
Create a new logging overridepost
List logging overrides
List logging overridesget
Get logging override status
Get logging override statusget

Limits
Limits
List limitsget

201Provides details for an EdgeWorker deactivation.