{ "opencollection": "1.0.0", "info": { "name": "Akamai: EdgeWorkers API", "version": "v1" }, "items": [ { "info": { "name": "Contracts", "type": "folder" }, "items": [ { "info": { "name": "Akamai List Contract IDs", "type": "http" }, "http": { "method": "GET", "url": "https://{hostname}/edgeworkers/v1/contracts", "params": [ { "name": "accountSwitchKey", "value": "{{accountSwitchKey}}", "type": "query", "description": "For customers who manage more than one account, this [runs the operation from another account](https://techdocs.akamai.com/developer/docs/manage-many-accounts-with-one-api-client). The Identity and Access Management API provides a [list of available account switch keys](https://techdocs.akamai.com/iam-api/reference/get-client-account-switch-keys)." } ] }, "docs": "View the list of contract IDs that you can use to list resource tiers." } ] }, { "info": { "name": "Permission groups", "type": "folder" }, "items": [ { "info": { "name": "Akamai List Permission Groups", "type": "http" }, "http": { "method": "GET", "url": "https://{hostname}/edgeworkers/v1/groups", "params": [ { "name": "accountSwitchKey", "value": "{{accountSwitchKey}}", "type": "query", "description": "For customers who manage more than one account, this [runs the operation from another account](https://techdocs.akamai.com/developer/docs/manage-many-accounts-with-one-api-client). The Identity and Access Management API provides a [list of available account switch keys](https://techdocs.akamai.com/iam-api/reference/get-client-account-switch-keys)." } ] }, "docs": "View a list of groups and the associated permission capabilities, for example: activate a version or fetch an EdgeWorker ID." }, { "info": { "name": "Akamai Get a Permission Group", "type": "http" }, "http": { "method": "GET", "url": "https://{hostname}/edgeworkers/v1/groups/:groupId", "params": [ { "name": "groupId", "value": "{{groupId}}", "type": "path", "description": "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](https://techdocs.akamai.com/property-mgr/reference/api/id-prefixes) for details." }, { "name": "accountSwitchKey", "value": "{{accountSwitchKey}}", "type": "query", "description": "For customers who manage more than one account, this [runs the operation from another account](https://techdocs.akamai.com/developer/docs/manage-many-accounts-with-one-api-client). The Identity and Access Management API provides a [list of available account switch keys](https://techdocs.akamai.com/iam-api/reference/get-client-account-switch-keys)." } ] }, "docs": "View details on the capabilities enabled within a specified group, for example: activate a version or fetch an EdgeWorker ID." } ] }, { "info": { "name": "EdgeWorker IDs", "type": "folder" }, "items": [ { "info": { "name": "Akamai List EdgeWorker IDs", "type": "http" }, "http": { "method": "GET", "url": "https://{hostname}/edgeworkers/v1/ids", "params": [ { "name": "groupId", "value": "{{groupId}}", "type": "query", "description": "Unique identifier for the Akamai group containing the EdgeWorker." }, { "name": "resourceTierId", "value": "{{resourceTierId}}", "type": "query", "description": "Unique identifier of the resource tier." }, { "name": "accountSwitchKey", "value": "{{accountSwitchKey}}", "type": "query", "description": "For customers who manage more than one account, this [runs the operation from another account](https://techdocs.akamai.com/developer/docs/manage-many-accounts-with-one-api-client). The Identity and Access Management API provides a [list of available account switch keys](https://techdocs.akamai.com/iam-api/reference/get-client-account-switch-keys)." } ] }, "docs": "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." }, { "info": { "name": "Akamai Create a New EdgeWorker ID", "type": "http" }, "http": { "method": "POST", "url": "https://{hostname}/edgeworkers/v1/ids", "params": [ { "name": "accountSwitchKey", "value": "{{accountSwitchKey}}", "type": "query", "description": "For customers who manage more than one account, this [runs the operation from another account](https://techdocs.akamai.com/developer/docs/manage-many-accounts-with-one-api-client). The Identity and Access Management API provides a [list of available account switch keys](https://techdocs.akamai.com/iam-api/reference/get-client-account-switch-keys)." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Register a new EdgeWorker within a particular group." }, { "info": { "name": "Akamai Get an EdgeWorker ID", "type": "http" }, "http": { "method": "GET", "url": "https://{hostname}/edgeworkers/v1/ids/:edgeWorkerId", "params": [ { "name": "edgeWorkerId", "value": "{{edgeWorkerId}}", "type": "path", "description": "Unique identifier for an EdgeWorker." }, { "name": "accountSwitchKey", "value": "{{accountSwitchKey}}", "type": "query", "description": "For customers who manage more than one account, this [runs the operation from another account](https://techdocs.akamai.com/developer/docs/manage-many-accounts-with-one-api-client). The Identity and Access Management API provides a [list of available account switch keys](https://techdocs.akamai.com/iam-api/reference/get-client-account-switch-keys)." } ] }, "docs": "View details for a specific EdgeWorker." }, { "info": { "name": "Akamai Update an EdgeWorker ID", "type": "http" }, "http": { "method": "PUT", "url": "https://{hostname}/edgeworkers/v1/ids/:edgeWorkerId", "params": [ { "name": "edgeWorkerId", "value": "{{edgeWorkerId}}", "type": "path", "description": "Unique identifier for an EdgeWorker." }, { "name": "accountSwitchKey", "value": "{{accountSwitchKey}}", "type": "query", "description": "For customers who manage more than one account, this [runs the operation from another account](https://techdocs.akamai.com/developer/docs/manage-many-accounts-with-one-api-client). The Identity and Access Management API provides a [list of available account switch keys](https://techdocs.akamai.com/iam-api/reference/get-client-account-switch-keys)." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update the `name` or `groupId` of an existing EdgeWorker." }, { "info": { "name": "Akamai Delete an EdgeWorker ID", "type": "http" }, "http": { "method": "DELETE", "url": "https://{hostname}/edgeworkers/v1/ids/:edgeWorkerId", "params": [ { "name": "edgeWorkerId", "value": "{{edgeWorkerId}}", "type": "path", "description": "Unique identifier for an EdgeWorker." }, { "name": "accountSwitchKey", "value": "{{accountSwitchKey}}", "type": "query", "description": "For customers who manage more than one account, this [runs the operation from another account](https://techdocs.akamai.com/developer/docs/manage-many-accounts-with-one-api-client). The Identity and Access Management API provides a [list of available account switch keys](https://techdocs.akamai.com/iam-api/reference/get-client-account-switch-keys)." } ] }, "docs": "Delete a specific EdgeWorker ID." }, { "info": { "name": "Akamai Clone an EdgeWorker ID", "type": "http" }, "http": { "method": "POST", "url": "https://{hostname}/edgeworkers/v1/ids/:edgeWorkerId/clone", "params": [ { "name": "edgeWorkerId", "value": "{{edgeWorkerId}}", "type": "path", "description": "Unique identifier for an EdgeWorker." }, { "name": "accountSwitchKey", "value": "{{accountSwitchKey}}", "type": "query", "description": "For customers who manage more than one account, this [runs the operation from another account](https://techdocs.akamai.com/developer/docs/manage-many-accounts-with-one-api-client). The Identity and Access Management API provides a [list of available account switch keys](https://techdocs.akamai.com/iam-api/reference/get-client-account-switch-keys)." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Clone an EdgeWorker ID to change the resource tier." }, { "info": { "name": "Akamai Get the Resource Tier", "type": "http" }, "http": { "method": "GET", "url": "https://{hostname}/edgeworkers/v1/ids/:edgeWorkerId/resource-tier", "params": [ { "name": "edgeWorkerId", "value": "{{edgeWorkerId}}", "type": "path", "description": "Unique identifier for an EdgeWorker." }, { "name": "accountSwitchKey", "value": "{{accountSwitchKey}}", "type": "query", "description": "For customers who manage more than one account, this [runs the operation from another account](https://techdocs.akamai.com/developer/docs/manage-many-accounts-with-one-api-client). The Identity and Access Management API provides a [list of available account switch keys](https://techdocs.akamai.com/iam-api/reference/get-client-account-switch-keys)." } ] }, "docs": "View the details of the resource tier assigned to the EdgeWorker ID." } ] }, { "info": { "name": "Activations", "type": "folder" }, "items": [ { "info": { "name": "Akamai List Activations", "type": "http" }, "http": { "method": "GET", "url": "https://{hostname}/edgeworkers/v1/ids/:edgeWorkerId/activations", "params": [ { "name": "edgeWorkerId", "value": "{{edgeWorkerId}}", "type": "path", "description": "Unique identifier for an EdgeWorker." }, { "name": "version", "value": "{{version}}", "type": "query", "description": "Unique identifier for a specific EdgeWorker version." }, { "name": "activeOnNetwork", "value": "{{activeOnNetwork}}", "type": "query", "description": "When enabled, limits results to show only currently activate versions. Pair this with a `network` to get the version that's currently active on a specific network. Otherwise the response may include up to two versions." }, { "name": "network", "value": "{{network}}", "type": "query", "description": "__Enum__ When enabled, limits results to show only versions activated on a specific network, either `STAGING` or `PRODUCTION`. Pair this with `activeOnNetwork=true` to get the version that's currently active on the specified network." }, { "name": "accountSwitchKey", "value": "{{accountSwitchKey}}", "type": "query", "description": "For customers who manage more than one account, this [runs the operation from another account](https://techdocs.akamai.com/developer/docs/manage-many-accounts-with-one-api-client). The Identity and Access Management API provides a [list of available account switch keys](https://techdocs.akamai.com/iam-api/reference/get-client-account-switch-keys)." } ] }, "docs": "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 activations down by version number." }, { "info": { "name": "Akamai Activate an EdgeWorker Version", "type": "http" }, "http": { "method": "POST", "url": "https://{hostname}/edgeworkers/v1/ids/:edgeWorkerId/activations", "params": [ { "name": "edgeWorkerId", "value": "{{edgeWorkerId}}", "type": "path", "description": "Unique identifier for an EdgeWorker." }, { "name": "accountSwitchKey", "value": "{{accountSwitchKey}}", "type": "query", "description": "For customers who manage more than one account, this [runs the operation from another account](https://techdocs.akamai.com/developer/docs/manage-many-accounts-with-one-api-client). The Identity and Access Management API provides a [list of available account switch keys](https://techdocs.akamai.com/iam-api/reference/get-client-account-switch-keys)." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Activate an existing EdgeWorker version on the Akamai network, either staging or production." }, { "info": { "name": "Akamai Roll Back to the Previous Active EdgeWorker Version", "type": "http" }, "http": { "method": "POST", "url": "https://{hostname}/edgeworkers/v1/ids/:edgeWorkerId/activations/rollback", "params": [ { "name": "edgeWorkerId", "value": "{{edgeWorkerId}}", "type": "path", "description": "Unique identifier for an EdgeWorker." }, { "name": "accountSwitchKey", "value": "{{accountSwitchKey}}", "type": "query", "description": "For customers who manage more than one account, this [runs the operation from another account](https://techdocs.akamai.com/developer/docs/manage-many-accounts-with-one-api-client). The Identity and Access Management API provides a [list of available account switch keys](https://techdocs.akamai.com/iam-api/reference/get-client-account-switch-keys)." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Reactivate the EdgeWorker version that was previously active on the Akamai network, either staging or production." }, { "info": { "name": "Akamai Get an Activation", "type": "http" }, "http": { "method": "GET", "url": "https://{hostname}/edgeworkers/v1/ids/:edgeWorkerId/activations/:activationId", "params": [ { "name": "activationId", "value": "{{activationId}}", "type": "path", "description": "Unique identifier for an EdgeWorkers activation." }, { "name": "edgeWorkerId", "value": "{{edgeWorkerId}}", "type": "path", "description": "Unique identifier for an EdgeWorker." }, { "name": "accountSwitchKey", "value": "{{accountSwitchKey}}", "type": "query", "description": "For customers who manage more than one account, this [runs the operation from another account](https://techdocs.akamai.com/developer/docs/manage-many-accounts-with-one-api-client). The Identity and Access Management API provides a [list of available account switch keys](https://techdocs.akamai.com/iam-api/reference/get-client-account-switch-keys)." } ] }, "docs": "View details for a specific activation." }, { "info": { "name": "Akamai Cancel an Activation", "type": "http" }, "http": { "method": "DELETE", "url": "https://{hostname}/edgeworkers/v1/ids/:edgeWorkerId/activations/:activationId", "params": [ { "name": "activationId", "value": "{{activationId}}", "type": "path", "description": "Unique identifier for an EdgeWorkers activation." }, { "name": "edgeWorkerId", "value": "{{edgeWorkerId}}", "type": "path", "description": "Unique identifier for an EdgeWorker." }, { "name": "accountSwitchKey", "value": "{{accountSwitchKey}}", "type": "query", "description": "For customers who manage more than one account, this [runs the operation from another account](https://techdocs.akamai.com/developer/docs/manage-many-accounts-with-one-api-client). The Identity and Access Management API provides a [list of available account switch keys](https://techdocs.akamai.com/iam-api/reference/get-client-account-switch-keys)." } ] }, "docs": "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 deactivate it. Once the deactivation is complete you can then delete the EdgeWorker version." } ] }, { "info": { "name": "Deactivations", "type": "folder" }, "items": [ { "info": { "name": "Akamai List Deactivations", "type": "http" }, "http": { "method": "GET", "url": "https://{hostname}/edgeworkers/v1/ids/:edgeWorkerId/deactivations", "params": [ { "name": "edgeWorkerId", "value": "{{edgeWorkerId}}", "type": "path", "description": "Unique identifier for an EdgeWorker." }, { "name": "version", "value": "{{version}}", "type": "query", "description": "Unique identifier for a specific EdgeWorker version." }, { "name": "accountSwitchKey", "value": "{{accountSwitchKey}}", "type": "query", "description": "For customers who manage more than one account, this [runs the operation from another account](https://techdocs.akamai.com/developer/docs/manage-many-accounts-with-one-api-client). The Identity and Access Management API provides a [list of available account switch keys](https://techdocs.akamai.com/iam-api/reference/get-client-account-switch-keys)." } ] }, "docs": "View the list of deactivations for an existing EdgeWorker. You can limit the results to a specific `version`." }, { "info": { "name": "Akamai Deactivate an EdgeWorker Version", "type": "http" }, "http": { "method": "POST", "url": "https://{hostname}/edgeworkers/v1/ids/:edgeWorkerId/deactivations", "params": [ { "name": "edgeWorkerId", "value": "{{edgeWorkerId}}", "type": "path", "description": "Unique identifier for an EdgeWorker." }, { "name": "accountSwitchKey", "value": "{{accountSwitchKey}}", "type": "query", "description": "For customers who manage more than one account, this [runs the operation from another account](https://techdocs.akamai.com/developer/docs/manage-many-accounts-with-one-api-client). The Identity and Access Management API provides a [list of available account switch keys](https://techdocs.akamai.com/iam-api/reference/get-client-account-switch-keys)." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Deactivate an existing EdgeWorker version on the Akamai network, either staging or production." }, { "info": { "name": "Akamai Get a Deactivation", "type": "http" }, "http": { "method": "GET", "url": "https://{hostname}/edgeworkers/v1/ids/:edgeWorkerId/deactivations/:deactivationId", "params": [ { "name": "deactivationId", "value": "{{deactivationId}}", "type": "path", "description": "Unique identifier for an EdgeWorker deactivation." }, { "name": "edgeWorkerId", "value": "{{edgeWorkerId}}", "type": "path", "description": "Unique identifier for an EdgeWorker." }, { "name": "accountSwitchKey", "value": "{{accountSwitchKey}}", "type": "query", "description": "For customers who manage more than one account, this [runs the operation from another account](https://techdocs.akamai.com/developer/docs/manage-many-accounts-with-one-api-client). The Identity and Access Management API provides a [list of available account switch keys](https://techdocs.akamai.com/iam-api/reference/get-client-account-switch-keys)." } ] }, "docs": "View details for a specific deactivation." } ] }, { "info": { "name": "Properties", "type": "folder" }, "items": [ { "info": { "name": "Akamai List Properties", "type": "http" }, "http": { "method": "GET", "url": "https://{hostname}/edgeworkers/v1/ids/:edgeWorkerId/properties", "params": [ { "name": "edgeWorkerId", "value": "{{edgeWorkerId}}", "type": "path", "description": "Unique identifier for an EdgeWorker." }, { "name": "activeOnly", "value": "{{activeOnly}}", "type": "query", "description": "When enabled, limits results to active properties." }, { "name": "accountSwitchKey", "value": "{{accountSwitchKey}}", "type": "query", "description": "For customers who manage more than one account, this [runs the operation from another account](https://techdocs.akamai.com/developer/docs/manage-many-accounts-with-one-api-client). The Identity and Access Management API provides a [list of available account switch keys](https://techdocs.akamai.com/iam-api/reference/get-client-account-switch-keys)." } ] }, "docs": "View the list of properties using an existing EdgeWorker ID. You can limit the results to active properties." } ] }, { "info": { "name": "Revisions", "type": "folder" }, "items": [ { "info": { "name": "Akamai List Revisions", "type": "http" }, "http": { "method": "GET", "url": "https://{hostname}/edgeworkers/v1/ids/:edgeWorkerId/revisions", "params": [ { "name": "edgeWorkerId", "value": "{{edgeWorkerId}}", "type": "path", "description": "Unique identifier for an EdgeWorker." }, { "name": "version", "value": "{{version}}", "type": "query", "description": "Unique identifier for a specific EdgeWorker version." }, { "name": "activationId", "value": "{{activationId}}", "type": "query", "description": "Filters results to a specific activation." }, { "name": "network", "value": "{{network}}", "type": "query", "description": "__Enum__ The network on which to use this authentication token, either `STAGING` or `PRODUCTION`. If not specified, the token is created for the network where the last property version activation occurred." }, { "name": "pinnedOnly", "value": "{{pinnedOnly}}", "type": "query", "description": "When enabled, limits results to show only currently or previously pinned revisions." }, { "name": "currentlyPinned", "value": "{{currentlyPinned}}", "type": "query", "description": "When enabled, limits results to show only revisions that are currently pinned." }, { "name": "accountSwitchKey", "value": "{{accountSwitchKey}}", "type": "query", "description": "For customers who manage more than one account, this [runs the operation from another account](https://techdocs.akamai.com/developer/docs/manage-many-accounts-with-one-api-client). The Identity and Access Management API provides a [list of available account switch keys](https://techdocs.akamai.com/iam-api/reference/get-client-account-switch-keys)." } ] }, "docs": "__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 Flexible composition refer to the [EdgeWorkers guide](https://techdocs.akamai.com/edgeworkers/docs/flexible-composition)." }, { "info": { "name": "Akamai List Revision Activations", "type": "http" }, "http": { "method": "GET", "url": "https://{hostname}/edgeworkers/v1/ids/:edgeWorkerId/revisions/activations", "params": [ { "name": "edgeWorkerId", "value": "{{edgeWorkerId}}", "type": "path", "description": "Unique identifier for an EdgeWorker." }, { "name": "version", "value": "{{version}}", "type": "query", "description": "Unique identifier for a specific EdgeWorker version." }, { "name": "activationId", "value": "{{activationId}}", "type": "query", "description": "Filters results to a specific activation." }, { "name": "network", "value": "{{network}}", "type": "query", "description": "__Enum__ The network on which to use this authentication token, either `STAGING` or `PRODUCTION`. If not specified, the token is created for the network where the last property version activation occurred." }, { "name": "accountSwitchKey", "value": "{{accountSwitchKey}}", "type": "query", "description": "For customers who manage more than one account, this [runs the operation from another account](https://techdocs.akamai.com/developer/docs/manage-many-accounts-with-one-api-client). The Identity and Access Management API provides a [list of available account switch keys](https://techdocs.akamai.com/iam-api/reference/get-client-account-switch-keys)." } ] }, "docs": "__Beta__ List activations for an existing EdgeWorker revision based on the EdgeWorker's ID. To learn more about Flexible composition refer to the [EdgeWorkers guide](https://techdocs.akamai.com/edgeworkers/docs/flexible-composition)." }, { "info": { "name": "Akamai Activate a Fallback Revision", "type": "http" }, "http": { "method": "POST", "url": "https://{hostname}/edgeworkers/v1/ids/:edgeWorkerId/revisions/activations", "params": [ { "name": "edgeWorkerId", "value": "{{edgeWorkerId}}", "type": "path", "description": "Unique identifier for an EdgeWorker." }, { "name": "accountSwitchKey", "value": "{{accountSwitchKey}}", "type": "query", "description": "For customers who manage more than one account, this [runs the operation from another account](https://techdocs.akamai.com/developer/docs/manage-many-accounts-with-one-api-client). The Identity and Access Management API provides a [list of available account switch keys](https://techdocs.akamai.com/iam-api/reference/get-client-account-switch-keys)." } ], "body": { "type": "json", "data": "{}" } }, "docs": "__Beta__ Reactivate a previously active revision on Akamai's staging or production network. To learn more about Flexible composition refer to the [EdgeWorkers guide](https://techdocs.akamai.com/edgeworkers/docs/flexible-composition)." }, { "info": { "name": "Akamai Get a Revision", "type": "http" }, "http": { "method": "GET", "url": "https://{hostname}/edgeworkers/v1/ids/:edgeWorkerId/revisions/:revisionId", "params": [ { "name": "revisionId", "value": "{{revisionId}}", "type": "path", "description": "Unique identifier for an EdgeWorkers revision." }, { "name": "edgeWorkerId", "value": "{{edgeWorkerId}}", "type": "path", "description": "Unique identifier for an EdgeWorker." }, { "name": "accountSwitchKey", "value": "{{accountSwitchKey}}", "type": "query", "description": "For customers who manage more than one account, this [runs the operation from another account](https://techdocs.akamai.com/developer/docs/manage-many-accounts-with-one-api-client). The Identity and Access Management API provides a [list of available account switch keys](https://techdocs.akamai.com/iam-api/reference/get-client-account-switch-keys)." } ] }, "docs": "__Beta__ View details for a specific revision. To learn more about Flexible composition refer to the [EdgeWorkers guide](https://techdocs.akamai.com/edgeworkers/docs/flexible-composition)." }, { "info": { "name": "Akamai Get a Revision BOM", "type": "http" }, "http": { "method": "GET", "url": "https://{hostname}/edgeworkers/v1/ids/:edgeWorkerId/revisions/:revisionId/bom", "params": [ { "name": "revisionId", "value": "{{revisionId}}", "type": "path", "description": "Unique identifier for an EdgeWorkers revision." }, { "name": "edgeWorkerId", "value": "{{edgeWorkerId}}", "type": "path", "description": "Unique identifier for an EdgeWorker." }, { "name": "includeActiveVersions", "value": "{{includeActiveVersions}}", "type": "query", "description": "When enabled, limits results to show only active versions." }, { "name": "includePinnedRevisions", "value": "{{includePinnedRevisions}}", "type": "query", "description": "When enabled, limits results to show only the pinned revisions when the BOM was created." }, { "name": "accountSwitchKey", "value": "{{accountSwitchKey}}", "type": "query", "description": "For customers who manage more than one account, this [runs the operation from another account](https://techdocs.akamai.com/developer/docs/manage-many-accounts-with-one-api-client). The Identity and Access Management API provides a [list of available account switch keys](https://techdocs.akamai.com/iam-api/reference/get-client-account-switch-keys)." } ] }, "docs": "__Beta__ View the Bill of Materials for a specific revision. To learn more about Flexible composition refer to the [EdgeWorkers guide](https://techdocs.akamai.com/edgeworkers/docs/flexible-composition)." }, { "info": { "name": "Akamai Compare Revisions", "type": "http" }, "http": { "method": "POST", "url": "https://{hostname}/edgeworkers/v1/ids/:edgeWorkerId/revisions/:revisionId/compare", "params": [ { "name": "revisionId", "value": "{{revisionId}}", "type": "path", "description": "Unique identifier for an EdgeWorkers revision." }, { "name": "edgeWorkerId", "value": "{{edgeWorkerId}}", "type": "path", "description": "Unique identifier for an EdgeWorker." }, { "name": "accountSwitchKey", "value": "{{accountSwitchKey}}", "type": "query", "description": "For customers who manage more than one account, this [runs the operation from another account](https://techdocs.akamai.com/developer/docs/manage-many-accounts-with-one-api-client). The Identity and Access Management API provides a [list of available account switch keys](https://techdocs.akamai.com/iam-api/reference/get-client-account-switch-keys)." } ], "body": { "type": "json", "data": "{}" } }, "docs": "__Beta__ View dependency differences between two revisions of the same EdgeWorker activation. To learn more about Flexible composition refer to the [EdgeWorkers guide](https://techdocs.akamai.com/edgeworkers/docs/flexible-composition)." }, { "info": { "name": "Akamai Download the Combined Code Bundle", "type": "http" }, "http": { "method": "GET", "url": "https://{hostname}/edgeworkers/v1/ids/:edgeWorkerId/revisions/:revisionId/content", "params": [ { "name": "revisionId", "value": "{{revisionId}}", "type": "path", "description": "Unique identifier for an EdgeWorkers revision." }, { "name": "edgeWorkerId", "value": "{{edgeWorkerId}}", "type": "path", "description": "Unique identifier for an EdgeWorker." }, { "name": "accountSwitchKey", "value": "{{accountSwitchKey}}", "type": "query", "description": "For customers who manage more than one account, this [runs the operation from another account](https://techdocs.akamai.com/developer/docs/manage-many-accounts-with-one-api-client). The Identity and Access Management API provides a [list of available account switch keys](https://techdocs.akamai.com/iam-api/reference/get-client-account-switch-keys)." } ] }, "docs": "__Beta__ Download the combined code bundle that contains the code and the dependencies that the EdgeWorker executes. To learn more about Flexible composition refer to the [EdgeWorkers guide](https://techdocs.akamai.com/edgeworkers/docs/flexible-composition)." }, { "info": { "name": "Akamai Pin an Active Revision", "type": "http" }, "http": { "method": "POST", "url": "https://{hostname}/edgeworkers/v1/ids/:edgeWorkerId/revisions/:revisionId/pin", "params": [ { "name": "edgeWorkerId", "value": "{{edgeWorkerId}}", "type": "path", "description": "Unique identifier for an EdgeWorker." }, { "name": "revisionId", "value": "{{revisionId}}", "type": "path", "description": "Unique identifier for an EdgeWorkers revision." }, { "name": "accountSwitchKey", "value": "{{accountSwitchKey}}", "type": "query", "description": "For customers who manage more than one account, this [runs the operation from another account](https://techdocs.akamai.com/developer/docs/manage-many-accounts-with-one-api-client). The Identity and Access Management API provides a [list of available account switch keys](https://techdocs.akamai.com/iam-api/reference/get-client-account-switch-keys)." } ], "body": { "type": "json", "data": "{}" } }, "docs": "__Beta__ Disable dynamic activation for an EdgeWorker revision on Akamai's staging or production network. To learn more about Flexible composition refer to the [EdgeWorkers guide](https://techdocs.akamai.com/edgeworkers/docs/flexible-composition)." }, { "info": { "name": "Akamai Unpin an Active Revision", "type": "http" }, "http": { "method": "POST", "url": "https://{hostname}/edgeworkers/v1/ids/:edgeWorkerId/revisions/:revisionId/unpin", "params": [ { "name": "edgeWorkerId", "value": "{{edgeWorkerId}}", "type": "path", "description": "Unique identifier for an EdgeWorker." }, { "name": "revisionId", "value": "{{revisionId}}", "type": "path", "description": "Unique identifier for an EdgeWorkers revision." }, { "name": "accountSwitchKey", "value": "{{accountSwitchKey}}", "type": "query", "description": "For customers who manage more than one account, this [runs the operation from another account](https://techdocs.akamai.com/developer/docs/manage-many-accounts-with-one-api-client). The Identity and Access Management API provides a [list of available account switch keys](https://techdocs.akamai.com/iam-api/reference/get-client-account-switch-keys)." } ], "body": { "type": "json", "data": "{}" } }, "docs": "__Beta__ Enable dynamic activation for an EdgeWorker revision on Akamai's staging or production network. To learn more about Flexible composition refer to the [EdgeWorkers guide](https://techdocs.akamai.com/edgeworkers/docs/flexible-composition)." } ] }, { "info": { "name": "Versions", "type": "folder" }, "items": [ { "info": { "name": "Akamai List Versions", "type": "http" }, "http": { "method": "GET", "url": "https://{hostname}/edgeworkers/v1/ids/:edgeWorkerId/versions", "params": [ { "name": "edgeWorkerId", "value": "{{edgeWorkerId}}", "type": "path", "description": "Unique identifier for an EdgeWorker." }, { "name": "accountSwitchKey", "value": "{{accountSwitchKey}}", "type": "query", "description": "For customers who manage more than one account, this [runs the operation from another account](https://techdocs.akamai.com/developer/docs/manage-many-accounts-with-one-api-client). The Identity and Access Management API provides a [list of available account switch keys](https://techdocs.akamai.com/iam-api/reference/get-client-account-switch-keys)." } ] }, "docs": "View a list of EdgeWorker versions." }, { "info": { "name": "Akamai Create a New Version", "type": "http" }, "http": { "method": "POST", "url": "https://{hostname}/edgeworkers/v1/ids/:edgeWorkerId/versions", "params": [ { "name": "edgeWorkerId", "value": "{{edgeWorkerId}}", "type": "path", "description": "Unique identifier for an EdgeWorker." }, { "name": "accountSwitchKey", "value": "{{accountSwitchKey}}", "type": "query", "description": "For customers who manage more than one account, this [runs the operation from another account](https://techdocs.akamai.com/developer/docs/manage-many-accounts-with-one-api-client). The Identity and Access Management API provides a [list of available account switch keys](https://techdocs.akamai.com/iam-api/reference/get-client-account-switch-keys)." } ] }, "docs": "Create a new version of an EdgeWorker. In order to run this operation you need to build an [EdgeWorkers code bundle](https://techdocs.akamai.com/edgeworkers/docs/create-a-code-bundle) and save it in GZIP format. You need to provide the GZIP binary file in the request body, with a `Content-Type` of `application/gzip`." }, { "info": { "name": "Akamai Get Version Details", "type": "http" }, "http": { "method": "GET", "url": "https://{hostname}/edgeworkers/v1/ids/:edgeWorkerId/versions/:version", "params": [ { "name": "version", "value": "{{version}}", "type": "path", "description": "Unique identifier for an EdgeWorker version." }, { "name": "edgeWorkerId", "value": "{{edgeWorkerId}}", "type": "path", "description": "Unique identifier for an EdgeWorker." }, { "name": "accountSwitchKey", "value": "{{accountSwitchKey}}", "type": "query", "description": "For customers who manage more than one account, this [runs the operation from another account](https://techdocs.akamai.com/developer/docs/manage-many-accounts-with-one-api-client). The Identity and Access Management API provides a [list of available account switch keys](https://techdocs.akamai.com/iam-api/reference/get-client-account-switch-keys)." } ] }, "docs": "View details for a specific version." }, { "info": { "name": "Akamai Delete Version", "type": "http" }, "http": { "method": "DELETE", "url": "https://{hostname}/edgeworkers/v1/ids/:edgeWorkerId/versions/:version", "params": [ { "name": "version", "value": "{{version}}", "type": "path", "description": "Unique identifier for an EdgeWorker version." }, { "name": "edgeWorkerId", "value": "{{edgeWorkerId}}", "type": "path", "description": "Unique identifier for an EdgeWorker." }, { "name": "accountSwitchKey", "value": "{{accountSwitchKey}}", "type": "query", "description": "For customers who manage more than one account, this [runs the operation from another account](https://techdocs.akamai.com/developer/docs/manage-many-accounts-with-one-api-client). The Identity and Access Management API provides a [list of available account switch keys](https://techdocs.akamai.com/iam-api/reference/get-client-account-switch-keys)." } ] }, "docs": "Delete a specific version." }, { "info": { "name": "Akamai Download an EdgeWorkers Code Bundle", "type": "http" }, "http": { "method": "GET", "url": "https://{hostname}/edgeworkers/v1/ids/:edgeWorkerId/versions/:version/content", "params": [ { "name": "version", "value": "{{version}}", "type": "path", "description": "Unique identifier for an EdgeWorker version." }, { "name": "edgeWorkerId", "value": "{{edgeWorkerId}}", "type": "path", "description": "Unique identifier for an EdgeWorker." }, { "name": "accountSwitchKey", "value": "{{accountSwitchKey}}", "type": "query", "description": "For customers who manage more than one account, this [runs the operation from another account](https://techdocs.akamai.com/developer/docs/manage-many-accounts-with-one-api-client). The Identity and Access Management API provides a [list of available account switch keys](https://techdocs.akamai.com/iam-api/reference/get-client-account-switch-keys)." } ] }, "docs": "Download the bundle containing the code the EdgeWorker executes." } ] }, { "info": { "name": "Limits", "type": "folder" }, "items": [ { "info": { "name": "Akamai List Limits", "type": "http" }, "http": { "method": "GET", "url": "https://{hostname}/edgeworkers/v1/limits", "params": [ { "name": "accountSwitchKey", "value": "{{accountSwitchKey}}", "type": "query", "description": "For customers who manage more than one account, this [runs the operation from another account](https://techdocs.akamai.com/developer/docs/manage-many-accounts-with-one-api-client). The Identity and Access Management API provides a [list of available account switch keys](https://techdocs.akamai.com/iam-api/reference/get-client-account-switch-keys)." } ] }, "docs": "View the various limits EdgeWorkers imposes on the number of activations, EdgeWorkers IDs, and versions you can deploy." } ] }, { "info": { "name": "Reports", "type": "folder" }, "items": [ { "info": { "name": "Akamai List Reports", "type": "http" }, "http": { "method": "GET", "url": "https://{hostname}/edgeworkers/v1/reports", "params": [ { "name": "accountSwitchKey", "value": "{{accountSwitchKey}}", "type": "query", "description": "For customers who manage more than one account, this [runs the operation from another account](https://techdocs.akamai.com/developer/docs/manage-many-accounts-with-one-api-client). The Identity and Access Management API provides a [list of available account switch keys](https://techdocs.akamai.com/iam-api/reference/get-client-account-switch-keys)." } ] }, "docs": "View a list of available reports. The data in these reports is also available in the [EdgeWorkers Management application](https://techdocs.akamai.com/edgeworkers/docs/manage-report-data)." }, { "info": { "name": "Akamai Get an EdgeWorker Report", "type": "http" }, "http": { "method": "GET", "url": "https://{hostname}/edgeworkers/v1/reports/:reportId", "params": [ { "name": "reportId", "value": "{{reportId}}", "type": "path", "description": "Unique identifier of an EdgeWorker report." }, { "name": "start", "value": "{{start}}", "type": "query", "description": "ISO 8601 timestamp indicating the start time of the EdgeWorker report." }, { "name": "end", "value": "{{end}}", "type": "query", "description": "ISO 8601 timestamp indicating the end time of the EdgeWorker report. If not specified, the end time defaults to the current time." }, { "name": "edgeWorker", "value": "{{edgeWorker}}", "type": "query", "description": "Filter by EdgeWorker ID such as `42` or more specific version such as `42-1.0`." }, { "name": "status", "value": "{{status}}", "type": "query", "description": "__Enum__ Filter by the EdgeWorker status, either `success`, `genericError`, `unknownEdgeWorkerId`, `unimplementedEventHandler`, `runtimeError`, `executionError`, `timeoutError`, `resourceLimitHit`, `cpuTimeoutError`, `wallTimeoutError`, `initCpuTimeoutError`, or `initWallTimeoutError`." }, { "name": "eventHandler", "value": "{{eventHandler}}", "type": "query", "description": "__Enum__ Filter EdgeWorkers by the event that triggers them, either `onClientRequest`, `onOriginRequest`, `onOriginResponse`, `onClientResponse`, or `responseProvider`." }, { "name": "accountSwitchKey", "value": "{{accountSwitchKey}}", "type": "query", "description": "For customers who manage more than one account, this [runs the operation from another account](https://techdocs.akamai.com/developer/docs/manage-many-accounts-with-one-api-client). The Identity and Access Management API provides a [list of available account switch keys](https://techdocs.akamai.com/iam-api/reference/get-client-account-switch-keys)." } ] }, "docs": "View details for a specific EdgeWorker." } ] }, { "info": { "name": "Resource tiers", "type": "folder" }, "items": [ { "info": { "name": "Akamai List Resource Tiers", "type": "http" }, "http": { "method": "GET", "url": "https://{hostname}/edgeworkers/v1/resource-tiers", "params": [ { "name": "contractId", "value": "{{contractId}}", "type": "query", "description": "Unique identifier of a contract." }, { "name": "accountSwitchKey", "value": "{{accountSwitchKey}}", "type": "query", "description": "For customers who manage more than one account, this [runs the operation from another account](https://techdocs.akamai.com/developer/docs/manage-many-accounts-with-one-api-client). The Identity and Access Management API provides a [list of available account switch keys](https://techdocs.akamai.com/iam-api/reference/get-client-account-switch-keys)." } ] }, "docs": "View the list of available resource tiers for a specific contract ID. The resource tier defines the resource consumption limits for an EdgeWorker ID." } ] }, { "info": { "name": "Secure tokens", "type": "folder" }, "items": [ { "info": { "name": "Akamai Create a Secure Token", "type": "http" }, "http": { "method": "POST", "url": "https://{hostname}/edgeworkers/v1/secure-token", "params": [ { "name": "accountSwitchKey", "value": "{{accountSwitchKey}}", "type": "query", "description": "For customers who manage more than one account, this [runs the operation from another account](https://techdocs.akamai.com/developer/docs/manage-many-accounts-with-one-api-client). The Identity and Access Management API provides a [list of available account switch keys](https://techdocs.akamai.com/iam-api/reference/get-client-account-switch-keys)." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Generate a JWT authentication token to [enable enhanced debug headers](https://techdocs.akamai.com/edgeworkers/docs/enable-enhanced-debug-headers) for EdgeWorkers." }, { "info": { "name": "Akamai Get a Secure Token", "type": "http" }, "http": { "method": "GET", "url": "https://{hostname}/edgeworkers/v1/secure-token/:propertyId", "params": [ { "name": "propertyId", "value": "{{propertyId}}", "type": "path", "description": "Unique identifier for a property." }, { "name": "acl", "value": "{{acl}}", "type": "query", "description": "Path prefix of the response pages to debug. This value can be a pattern that matches multiple pages, and is explicitly part of the final token. The default is `/*`. If you specify an `acl`, don't specify a `url`." }, { "name": "url", "value": "{{url}}", "type": "query", "description": "Exact path of the response pages to debug. This value is not explicitly part of the final token, but is used as a salt in the HMAC computation. If you specify a `url`, don't specify an `acl`." }, { "name": "expiry", "value": "{{expiry}}", "type": "query", "description": "Number of minutes before the authentication token expires, from a minute to an hour. The default is 15." }, { "name": "network", "value": "{{network}}", "type": "query", "description": "__Enum__ The network on which to use this authentication token, either `STAGING` or `PRODUCTION`. If not specified, the token is created for the network where the last property version activation occurred." }, { "name": "accountSwitchKey", "value": "{{accountSwitchKey}}", "type": "query", "description": "For customers who manage more than one account, this [runs the operation from another account](https://techdocs.akamai.com/developer/docs/manage-many-accounts-with-one-api-client). The Identity and Access Management API provides a [list of available account switch keys](https://techdocs.akamai.com/iam-api/reference/get-client-account-switch-keys)." } ] }, "docs": "__Deprecated__ Use the [Create a secure token](https://techdocs.akamai.com/edgeworkers/reference/post-secure-token) operation instead. This returns a generated authentication token, for use with enhanced debug headers for EdgeWorkers." } ] }, { "info": { "name": "Validations", "type": "folder" }, "items": [ { "info": { "name": "Akamai Validate an EdgeWorkers Code Bundle", "type": "http" }, "http": { "method": "POST", "url": "https://{hostname}/edgeworkers/v1/validations", "params": [ { "name": "accountSwitchKey", "value": "{{accountSwitchKey}}", "type": "query", "description": "For customers who manage more than one account, this [runs the operation from another account](https://techdocs.akamai.com/developer/docs/manage-many-accounts-with-one-api-client). The Identity and Access Management API provides a [list of available account switch keys](https://techdocs.akamai.com/iam-api/reference/get-client-account-switch-keys)." } ] }, "docs": "Return a list of errors and warnings containing details on how to fix your code bundle. See [Validation types](https://techdocs.akamai.com/edgeworkers/reference/validation-types). In order to run this operation you need to provide an EdgeWorkers code bundle as a GZIP binary file in the request body, with a `Content-Type` of `application/gzip`." } ] } ], "bundled": true }