{ "openapi": "3.0.0", "externalDocs": { "description": "See documentation for Akamai's EdgeWorkers API", "url": "https://techdocs.akamai.com/edgeworkers/reference" }, "info": { "title": "Akamai: EdgeWorkers API", "version": "v1", "license": { "name": "Apache 2.0", "url": "https://www.apache.org/licenses/LICENSE-2.0.html" } }, "paths": { "/contracts": { "get": { "description": "View the list of contract IDs that you can use to list resource tiers.", "operationId": "get-contracts", "summary": "Akamai List Contract IDs", "tags": [ "Contracts" ], "externalDocs": { "description": "See documentation for this operation in Akamai's EdgeWorkers API", "url": "https://techdocs.akamai.com/edgeworkers/reference/get-contracts" }, "responses": { "200": { "description": "This object provides a set of contract IDs that you can use to list resource tiers.", "content": { "application/json": { "example": { "contractIds": [ "1-599K", "B-M-28QYF3M" ] }, "schema": { "additionalProperties": false, "type": "object", "required": [ "contractIds" ], "properties": { "contractIds": { "description": "List of contract IDs.", "minItems": 1, "type": "array", "items": { "description": "List of contract IDs.", "minLength": 1, "type": "string" } } }, "x-akamai": { "file-path": "schemas/contract-ids-get-200.yaml" } } } } } }, "parameters": [ { "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).", "example": "{{accountSwitchKey}}", "in": "query", "name": "accountSwitchKey", "required": false, "schema": { "example": "1-5C0YLB:1-8BYUX", "type": "string" } } ] } }, "/groups": { "get": { "description": "View a list of groups and the associated permission capabilities, for example: activate a version or fetch an EdgeWorker ID.", "operationId": "get-groups", "summary": "Akamai List Permission Groups", "tags": [ "Permission groups" ], "externalDocs": { "description": "See documentation for this operation in Akamai's EdgeWorkers API", "url": "https://techdocs.akamai.com/edgeworkers/reference/get-groups" }, "responses": { "200": { "description": "Describes a list of EdgeWorker Groups.", "content": { "application/json": { "example": { "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" ] } ] }, "schema": { "additionalProperties": false, "type": "object", "required": [ "groups" ], "properties": { "groups": { "description": "List of EdgeWorker groups.", "minItems": 1, "type": "array", "items": { "additionalProperties": false, "type": "object", "required": [ "groupId", "groupName", "capabilities" ], "properties": { "capabilities": { "description": "List of EdgeWorker capabilities allowed within the group, including `VIEW`, `EDIT`, `VIEW_VERSION`, `CREATE_VERSION`, `VIEW_ACTIVATION`, and `ACTIVATE`.", "minItems": 1, "type": "array", "uniqueItems": true, "items": { "type": "string", "enum": [ "VIEW", "EDIT", "VIEW_VERSION", "CREATE_VERSION", "VIEW_ACTIVATION", "ACTIVATE" ] } }, "groupId": { "description": "Unique identifier of the Akamai group specified when the EdgeWorker was created.", "minimum": 1, "type": "integer" }, "groupName": { "description": "Name of the Akamai group specified when the EdgeWorker was created.", "minLength": 1, "type": "string" } }, "x-akamai": { "file-path": "schemas/group-get-200.yaml" } } } }, "x-akamai": { "file-path": "schemas/groups-get-200.yaml" } } } } } }, "parameters": [ { "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).", "example": "{{accountSwitchKey}}", "in": "query", "name": "accountSwitchKey", "required": false, "schema": { "example": "1-5C0YLB:1-8BYUX", "type": "string" } } ] } }, "/groups/{groupId}": { "get": { "description": "View details on the capabilities enabled within a specified group, for example: activate a version or fetch an EdgeWorker ID.", "operationId": "get-group", "summary": "Akamai Get a Permission Group", "tags": [ "Permission groups" ], "externalDocs": { "description": "See documentation for this operation in Akamai's EdgeWorkers API", "url": "https://techdocs.akamai.com/edgeworkers/reference/get-group" }, "responses": { "200": { "description": "This section describes EdgeWorker capabilities allowed within the Akamai group.", "content": { "application/json": { "example": { "groupId": 109795, "groupName": "ESSL Behavior Tests", "capabilities": [ "VIEW", "VIEW_VERSION", "VIEW_ACTIVATION" ] }, "schema": { "additionalProperties": false, "type": "object", "required": [ "groupId", "groupName", "capabilities" ], "properties": { "capabilities": { "description": "List of EdgeWorker capabilities allowed within the group, including `VIEW`, `EDIT`, `VIEW_VERSION`, `CREATE_VERSION`, `VIEW_ACTIVATION`, and `ACTIVATE`.", "minItems": 1, "type": "array", "uniqueItems": true, "items": { "type": "string", "enum": [ "VIEW", "EDIT", "VIEW_VERSION", "CREATE_VERSION", "VIEW_ACTIVATION", "ACTIVATE" ] } }, "groupId": { "description": "Unique identifier of the Akamai group specified when the EdgeWorker was created.", "minimum": 1, "type": "integer" }, "groupName": { "description": "Name of the Akamai group specified when the EdgeWorker was created.", "minLength": 1, "type": "string" } }, "x-akamai": { "file-path": "schemas/group-get-200.yaml" } } } } } }, "parameters": [ { "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).", "example": "{{accountSwitchKey}}", "in": "query", "name": "accountSwitchKey", "required": false, "schema": { "example": "1-5C0YLB:1-8BYUX", "type": "string" } } ] }, "parameters": [ { "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.", "example": "{{groupId}}", "in": "path", "name": "groupId", "required": true, "schema": { "example": 72297, "type": "number" }, "x-akamai": { "file-path": "parameters/groupId-path.yaml" } } ] }, "/ids": { "post": { "description": "Register a new EdgeWorker within a particular group.", "operationId": "post-ids", "summary": "Akamai Create a New EdgeWorker ID", "tags": [ "EdgeWorker IDs" ], "externalDocs": { "description": "See documentation for this operation in Akamai's EdgeWorkers API", "url": "https://techdocs.akamai.com/edgeworkers/reference/post-ids" }, "requestBody": { "required": true, "content": { "application/json": { "example": { "description": "Geo-blocking EdgeWorker", "groupId": 72297, "name": "Ew_42", "resourceTierId": 100 }, "schema": { "additionalProperties": false, "type": "object", "required": [ "groupId", "name", "resourceTierId" ], "properties": { "description": { "description": "Description of the EdgeWorker.", "example": "{{description}}", "maxLength": 128, "minLength": 1, "type": "string" }, "groupId": { "description": "Identifies a group to assign to the EdgeWorker.", "example": "{{groupId}}", "minimum": 1, "type": "integer" }, "name": { "description": "A name you assign to the EdgeWorker.", "example": "{{name}}", "minLength": 1, "type": "string" }, "resourceTierId": { "description": "Unique identifier of a resource tier. The resource tier is write-once data. To change the resource tier you need to [Clone an EdgeWorker ID](https://techdocs.akamai.com/edgeworkers/reference/post-id-clone).", "example": "{{resourceTierId}}", "minimum": 1, "type": "integer" } }, "x-akamai": { "file-path": "schemas/ids-post.yaml" } } } } }, "responses": { "201": { "description": "This section describes attributes of an EdgeWorker registration.", "content": { "application/json": { "example": { "accountId": "A-CCT7890", "createdBy": "jsmith", "createdTime": "2020-10-15T14:49:40Z", "description": "Geo-blocking EdgeWorker", "edgeWorkerId": 42, "groupId": 72297, "lastModifiedBy": "jsmith", "lastModifiedTime": "2020-10-15T15:21:15Z", "name": "Ew_42", "resourceTierId": 200 }, "schema": { "additionalProperties": false, "type": "object", "required": [ "name", "resourceTierId", "groupId" ], "properties": { "accountId": { "description": "Identifier for the account under which the EdgeWorker was created.", "minLength": 1, "type": "string" }, "createdBy": { "description": "Username of the person who created the EdgeWorker.", "minLength": 1, "type": "string" }, "createdTime": { "description": "ISO 8601 timestamp indicating when the EdgeWorker was created.", "format": "date-time", "type": "string" }, "description": { "description": "Description of the EdgeWorker.", "maxLength": 128, "minLength": 1, "type": "string" }, "edgeWorkerId": { "description": "Unique identifier of the EdgeWorker.", "minimum": 1, "type": "integer" }, "groupId": { "description": "Group identified by the user who created the EdgeWorker.", "minimum": 1, "type": "integer" }, "lastModifiedBy": { "description": "Username of the person who most recently updated the EdgeWorker.", "minLength": 1, "type": "string" }, "lastModifiedTime": { "description": "ISO 8601 timestamp indicating when the EdgeWorker was most recently modified.", "format": "date-time", "type": "string" }, "name": { "description": "Name given by the user who created the EdgeWorker.", "minLength": 1, "type": "string" }, "resourceTierId": { "description": "Resource tier selected when the EdgeWorker was created.", "minimum": 1, "type": "integer" } }, "x-akamai": { "file-path": "schemas/ids-post-201.yaml" } } } }, "headers": { "Location": { "description": "Use this URL to fetch the new resource.", "schema": { "type": "string" }, "x-akamai": { "file-path": "headers/Location.yaml" } } } } }, "parameters": [ { "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).", "example": "{{accountSwitchKey}}", "in": "query", "name": "accountSwitchKey", "required": false, "schema": { "example": "1-5C0YLB:1-8BYUX", "type": "string" } } ] }, "get": { "description": "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.", "operationId": "get-ids", "summary": "Akamai List EdgeWorker IDs", "tags": [ "EdgeWorker IDs" ], "externalDocs": { "description": "See documentation for this operation in Akamai's EdgeWorkers API", "url": "https://techdocs.akamai.com/edgeworkers/reference/get-ids" }, "responses": { "200": { "description": "Describes a list of EdgeWorker IDs.", "content": { "application/json": { "example": { "edgeWorkerIds": [ { "accountId": "A-CCT9012", "createdBy": "jsmith", "createdTime": "2020-10-15T14:49:40Z", "description": "Geo-blocking EdgeWorker", "edgeWorkerId": 1, "groupId": 72297, "lastModifiedBy": "jsmith", "lastModifiedTime": "2020-10-15T15:21:15Z", "name": "Ew_1", "resourceTierId": 100 }, { "accountId": "A-CCT7890", "createdBy": "jsmith", "createdTime": "2020-10-15T16:54:40Z", "edgeWorkerId": 2, "groupId": 72297, "lastModifiedBy": "jsmith", "lastModifiedTime": "2020-10-15T16:54:40Z", "name": "EdgeWorker #2", "resourceTierId": 200 } ] }, "schema": { "additionalProperties": false, "type": "object", "required": [ "edgeWorkerIds" ], "properties": { "edgeWorkerIds": { "description": "List of EdgeWorker IDs.", "minItems": 1, "type": "array", "items": { "additionalProperties": false, "type": "object", "required": [ "accountId", "createdBy", "createdTime", "edgeWorkerId", "groupId", "lastModifiedBy", "lastModifiedTime", "name", "resourceTierId" ], "properties": { "accountId": { "description": "Identifier for the account under which the EdgeWorker was created.", "minLength": 1, "type": "string" }, "createdBy": { "description": "Username of the person who created the EdgeWorker.", "minLength": 1, "type": "string" }, "createdTime": { "description": "ISO 8601 timestamp indicating when the EdgeWorker was created.", "format": "date-time", "type": "string" }, "description": { "description": "Description of the EdgeWorker.", "maxLength": 128, "minLength": 1, "type": "string" }, "edgeWorkerId": { "description": "Unique identifier of the EdgeWorker.", "minimum": 1, "type": "integer" }, "groupId": { "description": "Group identified by the user who created the EdgeWorker.", "minimum": 1, "type": "integer" }, "lastModifiedBy": { "description": "Username of the person who most recently updated the EdgeWorker.", "minLength": 1, "type": "string" }, "lastModifiedTime": { "description": "ISO 8601 timestamp indicating when the EdgeWorker was most recently modified.", "format": "date-time", "type": "string" }, "name": { "description": "Name given by the user who created the EdgeWorker.", "minLength": 1, "type": "string" }, "resourceTierId": { "description": "Resource tier selected when the EdgeWorker was created.", "minimum": 1, "type": "integer" } }, "x-akamai": { "file-path": "schemas/id-get-200.yaml" } } } }, "x-akamai": { "file-path": "schemas/ids-get-200.yaml" } } } } } }, "parameters": [ { "description": "Unique identifier for the Akamai group containing the EdgeWorker.", "example": "{{groupId}}", "in": "query", "name": "groupId", "schema": { "example": 72297, "type": "integer" }, "x-akamai": { "file-path": "parameters/groupId-query.yaml" } }, { "description": "Unique identifier of the resource tier.", "example": "{{resourceTierId}}", "in": "query", "name": "resourceTierId", "schema": { "example": 100, "type": "integer" }, "x-akamai": { "file-path": "parameters/resourceTierId-query.yaml" } }, { "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).", "example": "{{accountSwitchKey}}", "in": "query", "name": "accountSwitchKey", "required": false, "schema": { "example": "1-5C0YLB:1-8BYUX", "type": "string" } } ] } }, "/ids/{edgeWorkerId}": { "get": { "description": "View details for a specific EdgeWorker.", "operationId": "get-id", "summary": "Akamai Get an EdgeWorker ID", "tags": [ "EdgeWorker IDs" ], "externalDocs": { "description": "See documentation for this operation in Akamai's EdgeWorkers API", "url": "https://techdocs.akamai.com/edgeworkers/reference/get-id" }, "responses": { "200": { "description": "This section describes attributes of an EdgeWorker registration.", "content": { "application/json": { "example": { "accountId": "A-CCT3456", "createdBy": "jsmith", "createdTime": "2020-10-15T14:49:40Z", "description": "Geo-blocking EdgeWorker", "edgeWorkerId": 42, "groupId": 72297, "lastModifiedBy": "jsmith", "lastModifiedTime": "2020-10-15T15:21:15Z", "name": "Ew_1", "resourceTierId": 200 }, "schema": { "additionalProperties": false, "type": "object", "required": [ "accountId", "createdBy", "createdTime", "edgeWorkerId", "groupId", "lastModifiedBy", "lastModifiedTime", "name", "resourceTierId" ], "properties": { "accountId": { "description": "Identifier for the account under which the EdgeWorker was created.", "minLength": 1, "type": "string" }, "createdBy": { "description": "Username of the person who created the EdgeWorker.", "minLength": 1, "type": "string" }, "createdTime": { "description": "ISO 8601 timestamp indicating when the EdgeWorker was created.", "format": "date-time", "type": "string" }, "description": { "description": "Description of the EdgeWorker.", "maxLength": 128, "minLength": 1, "type": "string" }, "edgeWorkerId": { "description": "Unique identifier of the EdgeWorker.", "minimum": 1, "type": "integer" }, "groupId": { "description": "Group identified by the user who created the EdgeWorker.", "minimum": 1, "type": "integer" }, "lastModifiedBy": { "description": "Username of the person who most recently updated the EdgeWorker.", "minLength": 1, "type": "string" }, "lastModifiedTime": { "description": "ISO 8601 timestamp indicating when the EdgeWorker was most recently modified.", "format": "date-time", "type": "string" }, "name": { "description": "Name given by the user who created the EdgeWorker.", "minLength": 1, "type": "string" }, "resourceTierId": { "description": "Resource tier selected when the EdgeWorker was created.", "minimum": 1, "type": "integer" } }, "x-akamai": { "file-path": "schemas/id-get-200.yaml" } } } } } }, "parameters": [ { "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).", "example": "{{accountSwitchKey}}", "in": "query", "name": "accountSwitchKey", "required": false, "schema": { "example": "1-5C0YLB:1-8BYUX", "type": "string" } } ] }, "put": { "description": "Update the `name` or `groupId` of an existing EdgeWorker.", "operationId": "put-id", "summary": "Akamai Update an EdgeWorker ID", "tags": [ "EdgeWorker IDs" ], "externalDocs": { "description": "See documentation for this operation in Akamai's EdgeWorkers API", "url": "https://techdocs.akamai.com/edgeworkers/reference/put-id" }, "requestBody": { "required": true, "content": { "application/json": { "example": { "description": "New Description", "groupId": 123456, "name": "New EdgeWorker Name" }, "schema": { "additionalProperties": false, "type": "object", "properties": { "description": { "description": "Description of the EdgeWorker.", "example": "{{description}}", "maxLength": 128, "minLength": 0, "type": "string" }, "groupId": { "description": "Identifies a group to assign to the EdgeWorker.", "example": "{{groupId}}", "minimum": 1, "type": "integer" }, "name": { "description": "A name you assign to the EdgeWorker.", "example": "{{name}}", "minLength": 1, "type": "string" } }, "x-akamai": { "file-path": "schemas/id-put.yaml" } } } } }, "responses": { "200": { "description": "This section describes attributes of an EdgeWorker registration.", "content": { "application/json": { "example": { "accountId": "A-CCT9012", "createdBy": "jsmith", "createdTime": "2020-10-15T14:49:40Z", "description": "New Description", "edgeWorkerId": 42, "groupId": 72297, "lastModifiedBy": "jsmith", "lastModifiedTime": "2020-10-15T15:21:15Z", "name": "New EdgeWorker Name", "resourceTierId": 200 }, "schema": { "additionalProperties": false, "type": "object", "required": [ "accountId", "createdBy", "createdTime", "edgeWorkerId", "groupId", "lastModifiedBy", "lastModifiedTime", "name", "resourceTierId" ], "properties": { "accountId": { "description": "Identifier for the account under which the EdgeWorker was created.", "minLength": 1, "type": "string" }, "createdBy": { "description": "Username of the person who created the EdgeWorker.", "minLength": 1, "type": "string" }, "createdTime": { "description": "ISO 8601 timestamp indicating when the EdgeWorker was created.", "format": "date-time", "type": "string" }, "description": { "description": "Description of the EdgeWorker.", "maxLength": 128, "minLength": 1, "type": "string" }, "edgeWorkerId": { "description": "Unique identifier of the EdgeWorker.", "minimum": 1, "type": "integer" }, "groupId": { "description": "Group identified by the user who created the EdgeWorker.", "minimum": 1, "type": "integer" }, "lastModifiedBy": { "description": "Username of the person who most recently updated the EdgeWorker.", "minLength": 1, "type": "string" }, "lastModifiedTime": { "description": "ISO 8601 timestamp indicating when the EdgeWorker was most recently modified.", "format": "date-time", "type": "string" }, "name": { "description": "Name given by the user who created the EdgeWorker.", "minLength": 1, "type": "string" }, "resourceTierId": { "description": "Resource tier selected when the EdgeWorker was created.", "minimum": 1, "type": "integer" } }, "x-akamai": { "file-path": "schemas/id-put-200.yaml" } } } } } }, "parameters": [ { "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).", "example": "{{accountSwitchKey}}", "in": "query", "name": "accountSwitchKey", "required": false, "schema": { "example": "1-5C0YLB:1-8BYUX", "type": "string" } } ] }, "delete": { "description": "Delete a specific EdgeWorker ID.", "operationId": "delete-id", "summary": "Akamai Delete an EdgeWorker ID", "tags": [ "EdgeWorker IDs" ], "externalDocs": { "description": "See documentation for this operation in Akamai's EdgeWorkers API", "url": "https://techdocs.akamai.com/edgeworkers/reference/delete-id" }, "responses": { "204": { "description": "Confirms the deletion of the EdgeWorker ID.", "content": { "*/*": {} } } }, "parameters": [ { "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).", "example": "{{accountSwitchKey}}", "in": "query", "name": "accountSwitchKey", "required": false, "schema": { "example": "1-5C0YLB:1-8BYUX", "type": "string" } } ] }, "parameters": [ { "description": "Unique identifier for an EdgeWorker.", "example": "{{edgeWorkerId}}", "in": "path", "name": "edgeWorkerId", "required": true, "schema": { "example": 42, "minimum": 1, "type": "integer" }, "x-akamai": { "file-path": "parameters/edgeWorkerId-path.yaml" } } ] }, "/ids/{edgeWorkerId}/activations": { "post": { "description": "Activate an existing EdgeWorker version on the Akamai network, either staging or production.", "operationId": "post-activations", "summary": "Akamai Activate an EdgeWorker Version", "tags": [ "Activations" ], "externalDocs": { "description": "See documentation for this operation in Akamai's EdgeWorkers API", "url": "https://techdocs.akamai.com/edgeworkers/reference/post-activations" }, "requestBody": { "required": true, "content": { "application/json": { "example": { "network": "PRODUCTION", "note": "Version 2 fixes an issue detected in production.", "version": "2" }, "schema": { "additionalProperties": false, "type": "object", "required": [ "network", "version" ], "properties": { "network": { "description": "The network on which the version will be activated, either `STAGING` or `PRODUCTION`.", "example": "{{network}}", "type": "string", "enum": [ "STAGING", "PRODUCTION" ] }, "note": { "description": "Note to specify why the version is being activated.", "example": "{{note}}", "maxLength": 128, "minLength": 1, "type": "string" }, "version": { "description": "Unique identifier of the version that will be activated.", "example": "{{version}}", "minLength": 1, "type": "string" } }, "x-akamai": { "file-path": "schemas/activations-post.yaml" } } } } }, "responses": { "201": { "description": "Provides details for an EdgeWorker activation.", "content": { "application/json": { "example": { "accountId": "A-CCT3456", "activationId": 3, "createdBy": "jsmith", "createdTime": "2020-04-05T18:17:46Z", "edgeWorkerId": 42, "lastModifiedTime": "2020-04-05T18:17:46Z", "network": "PRODUCTION", "note": "Version 2 fixes an issue detected in production.", "status": "PRESUBMIT", "version": "2" }, "schema": { "additionalProperties": false, "type": "object", "required": [ "edgeWorkerId", "version", "activationId", "accountId", "status", "network", "createdBy", "createdTime", "lastModifiedTime" ], "properties": { "accountId": { "description": "Identifier for the account under which the EdgeWorker was created.", "minLength": 1, "type": "string" }, "activationId": { "description": "Unique identifier of the activation.", "minimum": 1, "type": "integer" }, "createdBy": { "description": "Username of the person who activated the EdgeWorker.", "minLength": 1, "type": "string" }, "createdTime": { "description": "ISO 8601 timestamp indicating when the EdgeWorker was activated.", "format": "date-time", "type": "string" }, "edgeWorkerId": { "description": "Unique identifier of the EdgeWorker.", "minimum": 1, "type": "integer" }, "lastModifiedTime": { "description": "ISO 8601 timestamp indicating when the activation was most recently modified.", "format": "date-time", "type": "string" }, "network": { "description": "The network on which the version is activated, either `PRODUCTION` or `STAGING`.", "type": "string", "enum": [ "STAGING", "PRODUCTION" ] }, "note": { "description": "Note to specify why the version is being activated.", "maxLength": 128, "minLength": 1, "type": "string" }, "status": { "description": "The activation status of the EdgeWorker version, either `PRESUBMIT`, `PENDING`, `IN_PROGRESS`, `COMPLETE`, `ABORTED`, `ERROR`, `DELETED_BY_AKAMAI`, or `EXPIRED`.", "type": "string", "enum": [ "PRESUBMIT", "PENDING", "IN_PROGRESS", "ABORTED", "ERROR", "COMPLETE", "DELETED_BY_AKAMAI", "EXPIRED", "CANCELLED" ] }, "version": { "description": "Unique identifier of the version.", "minLength": 1, "type": "string" } }, "x-akamai": { "file-path": "schemas/activations-post-201.yaml" } } } }, "headers": { "Location": { "description": "Use this URL to fetch the new resource.", "schema": { "type": "string" }, "x-akamai": { "file-path": "headers/Location.yaml" } } } } }, "parameters": [ { "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).", "example": "{{accountSwitchKey}}", "in": "query", "name": "accountSwitchKey", "required": false, "schema": { "example": "1-5C0YLB:1-8BYUX", "type": "string" } } ] }, "get": { "description": "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.", "operationId": "get-activations", "summary": "Akamai List Activations", "tags": [ "Activations" ], "externalDocs": { "description": "See documentation for this operation in Akamai's EdgeWorkers API", "url": "https://techdocs.akamai.com/edgeworkers/reference/get-activations" }, "responses": { "200": { "description": "This section describes a list of EdgeWorker activations.", "content": { "application/json": { "example": { "activations": [ { "accountId": "A-CCT7890", "activationId": 3, "createdBy": "jkowalski", "createdTime": "2020-07-09T09:03:28Z", "edgeWorkerId": 42, "lastModifiedTime": "2020-07-09T09:04:42Z", "network": "PRODUCTION", "note": "Version 2 fixes an issue detected in production.", "status": "PENDING", "version": "2" }, { "accountId": "A-CCT9012", "activationId": 1, "createdBy": "jsmith", "createdTime": "2020-07-09T08:13:54Z", "edgeWorkerId": 42, "lastModifiedTime": "2020-07-09T08:35:02Z", "network": "STAGING", "status": "IN_PROGRESS", "version": "1" }, { "accountId": "A-CCT5678", "activationId": 2, "createdBy": "adevi", "createdTime": "2020-07-10T14:23:42Z", "edgeWorkerId": 42, "lastModifiedTime": "2020-07-10T14:53:25Z", "network": "PRODUCTION", "status": "COMPLETE", "version": "2" } ] }, "schema": { "additionalProperties": false, "type": "object", "required": [ "activations" ], "properties": { "activations": { "description": "List of EdgeWorker activations.", "minItems": 1, "type": "array", "items": { "additionalProperties": false, "type": "object", "required": [ "edgeWorkerId", "version", "activationId", "accountId", "status", "network", "createdBy", "createdTime", "lastModifiedTime" ], "properties": { "accountId": { "description": "Identifier for the account under which the EdgeWorker was created.", "minLength": 1, "type": "string" }, "activationId": { "description": "Unique identifier of the activation.", "minimum": 1, "type": "integer" }, "createdBy": { "description": "Username of the person who created the EdgeWorker.", "minLength": 1, "type": "string" }, "createdTime": { "description": "ISO 8601 timestamp indicating when the EdgeWorker was created.", "format": "date-time", "type": "string" }, "edgeWorkerId": { "description": "Unique identifier of the EdgeWorker.", "minimum": 1, "type": "integer" }, "lastModifiedTime": { "description": "ISO 8601 timestamp indicating when the EdgeWorker was most recently modified.", "format": "date-time", "type": "string" }, "network": { "description": "The network on which the version is activated, either `PRODUCTION` or `STAGING`.", "type": "string", "enum": [ "STAGING", "PRODUCTION" ] }, "note": { "description": "Note to specify why the version is being activated.", "maxLength": 128, "minLength": 1, "type": "string" }, "status": { "description": "The activation status of the EdgeWorker version, either `PRESUBMIT`, `PENDING`, `IN_PROGRESS`, `COMPLETE`, `CANCELLED`, `ABORTED`, `ERROR`, `DELETED_BY_AKAMAI`, or `EXPIRED`.", "type": "string", "enum": [ "PRESUBMIT", "PENDING", "IN_PROGRESS", "ABORTED", "ERROR", "COMPLETE", "DELETED_BY_AKAMAI", "EXPIRED", "CANCELLED" ] }, "version": { "description": "Unique identifier of the version.", "minLength": 1, "type": "string" } }, "x-akamai": { "file-path": "schemas/activation-get-200.yaml" } } } }, "x-akamai": { "file-path": "schemas/activations-get-200.yaml" } } } } } }, "parameters": [ { "description": "Unique identifier for a specific EdgeWorker version.", "example": "{{version}}", "in": "query", "name": "version", "schema": { "example": "5", "type": "string" }, "x-akamai": { "file-path": "parameters/version-query.yaml" } }, { "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.", "example": "{{activeOnNetwork}}", "in": "query", "name": "activeOnNetwork", "schema": { "example": true, "type": "boolean" }, "x-akamai": { "file-path": "parameters/activeOnNetwork-query.yaml" } }, { "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.", "example": "{{network}}", "in": "query", "name": "network", "schema": { "example": "STAGING", "type": "string", "enum": [ "STAGING", "PRODUCTION" ] }, "x-akamai": { "file-path": "parameters/activationNetwork-query.yaml" } }, { "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).", "example": "{{accountSwitchKey}}", "in": "query", "name": "accountSwitchKey", "required": false, "schema": { "example": "1-5C0YLB:1-8BYUX", "type": "string" } } ] }, "parameters": [ { "description": "Unique identifier for an EdgeWorker.", "example": "{{edgeWorkerId}}", "in": "path", "name": "edgeWorkerId", "required": true, "schema": { "example": 42, "minimum": 1, "type": "integer" }, "x-akamai": { "file-path": "parameters/edgeWorkerId-path.yaml" } } ] }, "/ids/{edgeWorkerId}/activations/rollback": { "post": { "description": "Reactivate the EdgeWorker version that was previously active on the Akamai network, either staging or production.", "operationId": "post-rollback-to-previous-active-version", "summary": "Akamai Roll Back to the Previous Active EdgeWorker Version", "tags": [ "Activations" ], "externalDocs": { "description": "See documentation for this operation in Akamai's EdgeWorkers API", "url": "https://techdocs.akamai.com/edgeworkers/reference/post-rollback-to-previous-active-version" }, "requestBody": { "required": true, "content": { "application/json": { "example": { "network": "STAGING", "note": "An issue was detected in the latest active version." }, "schema": { "additionalProperties": false, "type": "object", "required": [ "network" ], "properties": { "network": { "description": "The network on which the version previously active will be reactivated, either `STAGING` or `PRODUCTION`.", "example": "{{network}}", "type": "string", "enum": [ "STAGING", "PRODUCTION" ] }, "note": { "description": "Note to specify the reason for the rollback.", "example": "{{note}}", "maxLength": 128, "minLength": 1, "type": "string" } }, "x-akamai": { "file-path": "schemas/activation-rollback-post.yaml" } } } } }, "responses": { "201": { "description": "Provides details for an EdgeWorker activation.", "content": { "application/json": { "example": { "accountId": "A-CCT5678", "activationId": 3, "createdBy": "jsmith", "createdTime": "2020-04-05T18:17:46Z", "edgeWorkerId": 42, "lastModifiedTime": "2020-04-05T18:17:46Z", "network": "PRODUCTION", "note": "Version 2 fixes an issue detected in production.", "status": "PRESUBMIT", "version": "2" }, "schema": { "additionalProperties": false, "type": "object", "required": [ "edgeWorkerId", "version", "activationId", "accountId", "status", "network", "createdBy", "createdTime", "lastModifiedTime" ], "properties": { "accountId": { "description": "Identifier for the account under which the EdgeWorker was created.", "minLength": 1, "type": "string" }, "activationId": { "description": "Unique identifier of the activation.", "minimum": 1, "type": "integer" }, "createdBy": { "description": "Username of the person who activated the EdgeWorker.", "minLength": 1, "type": "string" }, "createdTime": { "description": "ISO 8601 timestamp indicating when the EdgeWorker was activated.", "format": "date-time", "type": "string" }, "edgeWorkerId": { "description": "Unique identifier of the EdgeWorker.", "minimum": 1, "type": "integer" }, "lastModifiedTime": { "description": "ISO 8601 timestamp indicating when the activation was most recently modified.", "format": "date-time", "type": "string" }, "network": { "description": "The network on which the version is activated, either `PRODUCTION` or `STAGING`.", "type": "string", "enum": [ "STAGING", "PRODUCTION" ] }, "note": { "description": "Note to specify why the version is being activated.", "maxLength": 128, "minLength": 1, "type": "string" }, "status": { "description": "The activation status of the EdgeWorker version, either `PRESUBMIT`, `PENDING`, `IN_PROGRESS`, `COMPLETE`, `ABORTED`, `ERROR`, `DELETED_BY_AKAMAI`, or `EXPIRED`.", "type": "string", "enum": [ "PRESUBMIT", "PENDING", "IN_PROGRESS", "ABORTED", "ERROR", "COMPLETE", "DELETED_BY_AKAMAI", "EXPIRED", "CANCELLED" ] }, "version": { "description": "Unique identifier of the version.", "minLength": 1, "type": "string" } }, "x-akamai": { "file-path": "schemas/activations-post-201.yaml" } } } }, "headers": { "Location": { "description": "Use this URL to fetch the new resource.", "schema": { "type": "string" }, "x-akamai": { "file-path": "headers/Location.yaml" } } } } }, "parameters": [ { "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).", "example": "{{accountSwitchKey}}", "in": "query", "name": "accountSwitchKey", "required": false, "schema": { "example": "1-5C0YLB:1-8BYUX", "type": "string" } } ] }, "parameters": [ { "description": "Unique identifier for an EdgeWorker.", "example": "{{edgeWorkerId}}", "in": "path", "name": "edgeWorkerId", "required": true, "schema": { "example": 42, "minimum": 1, "type": "integer" }, "x-akamai": { "file-path": "parameters/edgeWorkerId-path.yaml" } } ] }, "/ids/{edgeWorkerId}/activations/{activationId}": { "get": { "description": "View details for a specific activation.", "operationId": "get-activation", "summary": "Akamai Get an Activation", "tags": [ "Activations" ], "externalDocs": { "description": "See documentation for this operation in Akamai's EdgeWorkers API", "url": "https://techdocs.akamai.com/edgeworkers/reference/get-activation" }, "responses": { "200": { "description": "Provides details for an EdgeWorker activation.", "content": { "application/json": { "example": { "accountId": "A-CCT1234", "activationId": 3, "createdBy": "jsmith", "createdTime": "2020-08-04T11:42:56Z", "edgeWorkerId": 42, "lastModifiedTime": "2020-08-04T12:00:03Z", "network": "PRODUCTION", "note": "Version 2 fixes an issue detected in production.", "status": "PENDING", "version": "2" }, "schema": { "additionalProperties": false, "type": "object", "required": [ "edgeWorkerId", "version", "activationId", "accountId", "status", "network", "createdBy", "createdTime", "lastModifiedTime" ], "properties": { "accountId": { "description": "Identifier for the account under which the EdgeWorker was created.", "minLength": 1, "type": "string" }, "activationId": { "description": "Unique identifier of the activation.", "minimum": 1, "type": "integer" }, "createdBy": { "description": "Username of the person who created the EdgeWorker.", "minLength": 1, "type": "string" }, "createdTime": { "description": "ISO 8601 timestamp indicating when the EdgeWorker was created.", "format": "date-time", "type": "string" }, "edgeWorkerId": { "description": "Unique identifier of the EdgeWorker.", "minimum": 1, "type": "integer" }, "lastModifiedTime": { "description": "ISO 8601 timestamp indicating when the EdgeWorker was most recently modified.", "format": "date-time", "type": "string" }, "network": { "description": "The network on which the version is activated, either `PRODUCTION` or `STAGING`.", "type": "string", "enum": [ "STAGING", "PRODUCTION" ] }, "note": { "description": "Note to specify why the version is being activated.", "maxLength": 128, "minLength": 1, "type": "string" }, "status": { "description": "The activation status of the EdgeWorker version, either `PRESUBMIT`, `PENDING`, `IN_PROGRESS`, `COMPLETE`, `CANCELLED`, `ABORTED`, `ERROR`, `DELETED_BY_AKAMAI`, or `EXPIRED`.", "type": "string", "enum": [ "PRESUBMIT", "PENDING", "IN_PROGRESS", "ABORTED", "ERROR", "COMPLETE", "DELETED_BY_AKAMAI", "EXPIRED", "CANCELLED" ] }, "version": { "description": "Unique identifier of the version.", "minLength": 1, "type": "string" } }, "x-akamai": { "file-path": "schemas/activation-get-200.yaml" } } } } } }, "parameters": [ { "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).", "example": "{{accountSwitchKey}}", "in": "query", "name": "accountSwitchKey", "required": false, "schema": { "example": "1-5C0YLB:1-8BYUX", "type": "string" } } ] }, "delete": { "description": "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.", "operationId": "delete-activation", "summary": "Akamai Cancel an Activation", "tags": [ "Activations" ], "externalDocs": { "description": "See documentation for this operation in Akamai's EdgeWorkers API", "url": "https://techdocs.akamai.com/edgeworkers/reference/delete-activation" }, "responses": { "200": { "description": "Provides details for an EdgeWorker activation.", "content": { "application/json": { "example": { "accountId": "A-CCT1234", "activationId": 3, "createdBy": "jsmith", "createdTime": "2020-08-04T11:42:56Z", "edgeWorkerId": 42, "lastModifiedTime": "2020-08-04T12:00:03Z", "network": "PRODUCTION", "note": "Version 2 fixes an issue detected in production.", "status": "CANCELLED", "version": "2" }, "schema": { "additionalProperties": false, "type": "object", "required": [ "edgeWorkerId", "version", "activationId", "accountId", "status", "network", "createdBy", "createdTime", "lastModifiedTime" ], "properties": { "accountId": { "description": "Identifier for the account under which the EdgeWorker was created.", "minLength": 1, "type": "string" }, "activationId": { "description": "Unique identifier of the activation.", "minimum": 1, "type": "integer" }, "createdBy": { "description": "Username of the person who created the EdgeWorker.", "minLength": 1, "type": "string" }, "createdTime": { "description": "ISO 8601 timestamp indicating when the EdgeWorker was created.", "format": "date-time", "type": "string" }, "edgeWorkerId": { "description": "Unique identifier of the EdgeWorker.", "minimum": 1, "type": "integer" }, "lastModifiedTime": { "description": "ISO 8601 timestamp indicating when the EdgeWorker was most recently modified.", "format": "date-time", "type": "string" }, "network": { "description": "The network on which the version is activated, either `PRODUCTION` or `STAGING`.", "type": "string", "enum": [ "STAGING", "PRODUCTION" ] }, "note": { "description": "Note to specify why the version is being activated.", "maxLength": 128, "minLength": 1, "type": "string" }, "status": { "description": "The activation status of the EdgeWorker version is `CANCELLED` after you cancel a `PRESUBMIT` or `PENDING` activation.", "type": "string", "enum": [ "PRESUBMIT", "PENDING", "IN_PROGRESS", "ABORTED", "ERROR", "COMPLETE", "DELETED_BY_AKAMAI", "EXPIRED", "CANCELLED" ] }, "version": { "description": "Unique identifier of the version.", "minLength": 1, "type": "string" } }, "x-akamai": { "file-path": "schemas/activation-delete-200.yaml" } } } } } }, "parameters": [ { "description": "Unique identifier for an EdgeWorkers activation.", "example": "{{activationId}}", "in": "path", "name": "activationId", "required": true, "schema": { "example": 3, "minimum": 1, "type": "integer" }, "x-akamai": { "file-path": "parameters/activationId-path.yaml" } }, { "description": "Unique identifier for an EdgeWorker.", "example": "{{edgeWorkerId}}", "in": "path", "name": "edgeWorkerId", "required": true, "schema": { "example": 42, "minimum": 1, "type": "integer" }, "x-akamai": { "file-path": "parameters/edgeWorkerId-path.yaml" } }, { "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).", "example": "{{accountSwitchKey}}", "in": "query", "name": "accountSwitchKey", "required": false, "schema": { "example": "1-5C0YLB:1-8BYUX", "type": "string" } } ] }, "parameters": [ { "description": "Unique identifier for an EdgeWorkers activation.", "example": "{{activationId}}", "in": "path", "name": "activationId", "required": true, "schema": { "example": 3, "minimum": 1, "type": "integer" }, "x-akamai": { "file-path": "parameters/activationId-path.yaml" } }, { "description": "Unique identifier for an EdgeWorker.", "example": "{{edgeWorkerId}}", "in": "path", "name": "edgeWorkerId", "required": true, "schema": { "example": 42, "minimum": 1, "type": "integer" }, "x-akamai": { "file-path": "parameters/edgeWorkerId-path.yaml" } } ] }, "/ids/{edgeWorkerId}/clone": { "post": { "description": "Clone an EdgeWorker ID to change the resource tier.", "operationId": "post-id-clone", "summary": "Akamai Clone an EdgeWorker ID", "tags": [ "EdgeWorker IDs" ], "externalDocs": { "description": "See documentation for this operation in Akamai's EdgeWorkers API", "url": "https://techdocs.akamai.com/edgeworkers/reference/post-id-clone" }, "requestBody": { "required": true, "content": { "application/json": { "example": { "description": "Clone of EdgeWorker ID 42", "groupId": 72297, "name": "Ew_42", "resourceTierId": 200 }, "schema": { "additionalProperties": false, "type": "object", "required": [ "resourceTierId" ], "properties": { "description": { "description": "Description of the EdgeWorker.", "example": "{{description}}", "maxLength": 128, "minLength": 0, "type": "string" }, "groupId": { "description": "Identifies a group to assign to the EdgeWorker.", "example": "{{groupId}}", "minimum": 1, "type": "integer" }, "name": { "description": "A name you assign to the EdgeWorker.", "example": "{{name}}", "minLength": 1, "type": "string" }, "resourceTierId": { "description": "Unique identifier of a resource tier.", "example": "{{resourceTierId}}", "minimum": 1, "type": "integer" } }, "x-akamai": { "file-path": "schemas/id-clone.yaml" } } } } }, "responses": { "201": { "description": "This section describes attributes of an EdgeWorker registration.", "content": { "application/json": { "example": { "accountId": "A-CCT5678", "createdBy": "jsmith", "createdTime": "2020-10-15T14:49:40Z", "description": "Clone of EdgeWorker ID 42", "edgeWorkerId": 43, "groupId": 72297, "lastModifiedBy": "jsmith", "lastModifiedTime": "2020-10-15T15:21:15Z", "name": "Ew_42", "resourceTierId": 100, "sourceEdgeWorkerId": 42 }, "schema": { "additionalProperties": false, "type": "object", "required": [ "accountId", "createdBy", "createdTime", "edgeWorkerId", "groupId", "lastModifiedBy", "lastModifiedTime", "name", "resourceTierId", "sourceEdgeWorkerId" ], "properties": { "accountId": { "description": "Identifier for the account under which the EdgeWorker was created.", "minLength": 1, "type": "string" }, "createdBy": { "description": "Username of the person who created the EdgeWorker.", "minLength": 1, "type": "string" }, "createdTime": { "description": "ISO 8601 timestamp indicating when the EdgeWorker was created.", "format": "date-time", "type": "string" }, "description": { "description": "Description of the EdgeWorker.", "maxLength": 128, "minLength": 1, "type": "string" }, "edgeWorkerId": { "description": "Unique identifier of the EdgeWorker.", "minimum": 1, "type": "integer" }, "groupId": { "description": "Group identified by the user who created the EdgeWorker.", "minimum": 1, "type": "integer" }, "lastModifiedBy": { "description": "Username of the person who most recently updated the EdgeWorker.", "minLength": 1, "type": "string" }, "lastModifiedTime": { "description": "ISO 8601 timestamp indicating when the EdgeWorker was most recently modified.", "format": "date-time", "type": "string" }, "name": { "description": "Name given by the user who created the EdgeWorker.", "minLength": 1, "type": "string" }, "resourceTierId": { "description": "Resource tier selected when the EdgeWorker was created.", "minimum": 1, "type": "integer" }, "sourceEdgeWorkerId": { "description": "EdgeWorker ID used to create the current EdgeWorker ID. The `sourceEdgeWorkerId` also appears when you view the details of a cloned EdgeWorker ID using the [Get an Edgeworker ID](https://techdocs.akamai.com/edgeworkers/reference/get-id) operation.", "minimum": 1, "type": "integer" } }, "x-akamai": { "file-path": "schemas/id-clone-201.yaml" } } } }, "headers": { "Location": { "description": "Use this URL to fetch the new resource.", "schema": { "type": "string" }, "x-akamai": { "file-path": "headers/Location.yaml" } } } } }, "parameters": [ { "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).", "example": "{{accountSwitchKey}}", "in": "query", "name": "accountSwitchKey", "required": false, "schema": { "example": "1-5C0YLB:1-8BYUX", "type": "string" } } ] }, "parameters": [ { "description": "Unique identifier for an EdgeWorker.", "example": "{{edgeWorkerId}}", "in": "path", "name": "edgeWorkerId", "required": true, "schema": { "example": 42, "minimum": 1, "type": "integer" }, "x-akamai": { "file-path": "parameters/edgeWorkerId-path.yaml" } } ] }, "/ids/{edgeWorkerId}/deactivations": { "post": { "description": "Deactivate an existing EdgeWorker version on the Akamai network, either staging or production.", "operationId": "post-deactivations", "summary": "Akamai Deactivate an EdgeWorker Version", "tags": [ "Deactivations" ], "externalDocs": { "description": "See documentation for this operation in Akamai's EdgeWorkers API", "url": "https://techdocs.akamai.com/edgeworkers/reference/post-deactivations" }, "requestBody": { "required": true, "content": { "application/json": { "example": { "network": "PRODUCTION", "note": "EdgeWorker ID 42 is no longer used in production.", "version": "2" }, "schema": { "additionalProperties": false, "type": "object", "required": [ "network", "version" ], "properties": { "network": { "description": "The network on which the version will be deactivated, either `STAGING` or `PRODUCTION`.", "example": "{{network}}", "type": "string", "enum": [ "STAGING", "PRODUCTION" ] }, "note": { "description": "Note to specify why the version is being deactivated.", "example": "{{note}}", "minLength": 1, "type": "string" }, "version": { "description": "Unique identifier of the version that will be deactivated.", "example": "{{version}}", "minLength": 1, "type": "string" } }, "x-akamai": { "file-path": "schemas/deactivations-post.yaml" } } } } }, "responses": { "201": { "description": "Provides details for an EdgeWorker deactivation.", "content": { "application/json": { "example": { "accountId": "A-CCT3456", "createdBy": "jsmith", "createdTime": "2020-04-05T18:17:46Z", "deactivationId": 3, "edgeWorkerId": 42, "lastModifiedTime": "2020-04-05T18:17:46Z", "network": "PRODUCTION", "note": "EdgeWorker ID 42 is no longer used in production.", "status": "PRESUBMIT", "version": "5" }, "schema": { "additionalProperties": false, "type": "object", "required": [ "edgeWorkerId", "version", "deactivationId", "accountId", "status", "network", "createdBy", "createdTime", "lastModifiedTime" ], "properties": { "accountId": { "description": "Identifier for the account under which the EdgeWorker was created.", "minLength": 1, "type": "string" }, "createdBy": { "description": "Username of the person who created the EdgeWorker.", "minLength": 1, "type": "string" }, "createdTime": { "description": "ISO 8601 timestamp indicating when the EdgeWorker was created.", "format": "date-time", "type": "string" }, "deactivationId": { "description": "Unique identifier of the deactivation.", "minimum": 1, "type": "integer" }, "edgeWorkerId": { "description": "Unique identifier of the EdgeWorker.", "minimum": 1, "type": "integer" }, "lastModifiedTime": { "description": "ISO 8601 timestamp indicating when the EdgeWorker was most recently modified.", "format": "date-time", "type": "string" }, "network": { "description": "The network on which the version is deactivated, either `PRODUCTION` or `STAGING`.", "type": "string", "enum": [ "STAGING", "PRODUCTION" ] }, "note": { "description": "Note to specify why the version is being deactivated.", "minLength": 1, "type": "string" }, "status": { "description": "The deactivation status of the EdgeWorker version, either `PRESUBMIT`, `PENDING`, `IN_PROGRESS`, `COMPLETE`, `ABORTED`, `ERROR`, `DELETED_BY_AKAMAI`, or `EXPIRED`.", "type": "string", "enum": [ "PRESUBMIT", "PENDING", "IN_PROGRESS", "ABORTED", "ERROR", "COMPLETE", "DELETED_BY_AKAMAI", "EXPIRED", "CANCELLED" ] }, "version": { "description": "Unique identifier of the version.", "minLength": 1, "type": "string" } }, "x-akamai": { "file-path": "schemas/deactivations-post-201.yaml" } } } }, "headers": { "Location": { "description": "Use this URL to fetch the new resource.", "schema": { "type": "string" }, "x-akamai": { "file-path": "headers/Location.yaml" } } } } }, "parameters": [ { "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).", "example": "{{accountSwitchKey}}", "in": "query", "name": "accountSwitchKey", "required": false, "schema": { "example": "1-5C0YLB:1-8BYUX", "type": "string" } } ] }, "get": { "description": "View the list of deactivations for an existing EdgeWorker. You can limit the results to a specific `version`.", "operationId": "get-deactivations", "summary": "Akamai List Deactivations", "tags": [ "Deactivations" ], "externalDocs": { "description": "See documentation for this operation in Akamai's EdgeWorkers API", "url": "https://techdocs.akamai.com/edgeworkers/reference/get-deactivations" }, "responses": { "200": { "description": "This section describes a list of EdgeWorker deactivations.", "content": { "application/json": { "example": { "deactivations": [ { "accountId": "A-CCT7890", "createdBy": "jperez", "createdTime": "2020-07-09T09:03:28Z", "deactivationId": 3, "edgeWorkerId": 42, "lastModifiedTime": "2020-07-09T09:04:42Z", "network": "PRODUCTION", "note": "EdgeWorker ID 42 is no longer used in production.", "status": "PENDING", "version": "2" }, { "accountId": "A-CCT7890", "createdBy": "jsmith", "createdTime": "2020-07-09T08:13:54Z", "deactivationId": 1, "edgeWorkerId": 42, "lastModifiedTime": "2020-07-09T08:35:02Z", "network": "STAGING", "status": "IN_PROGRESS", "version": "1" }, { "accountId": "A-CCT7890", "createdBy": "jsmith", "createdTime": "2020-07-10T14:23:42Z", "deactivationId": 2, "edgeWorkerId": 42, "lastModifiedTime": "2020-07-10T14:53:25Z", "network": "PRODUCTION", "status": "COMPLETE", "version": "2" } ] }, "schema": { "additionalProperties": false, "type": "object", "required": [ "deactivations" ], "properties": { "deactivations": { "description": "List of EdgeWorker deactivations.", "minItems": 0, "type": "array", "items": { "additionalProperties": false, "type": "object", "required": [ "edgeWorkerId", "version", "deactivationId", "accountId", "status", "network", "createdBy", "createdTime", "lastModifiedTime" ], "properties": { "accountId": { "description": "Identifier for the account under which the EdgeWorker was created.", "minLength": 1, "type": "string" }, "createdBy": { "description": "Username of the person who created the EdgeWorker.", "minLength": 1, "type": "string" }, "createdTime": { "description": "ISO 8601 timestamp indicating when the EdgeWorker was created.", "format": "date-time", "type": "string" }, "deactivationId": { "description": "Unique identifier of the deactivation.", "minimum": 1, "type": "integer" }, "edgeWorkerId": { "description": "Unique identifier of the EdgeWorker.", "minimum": 1, "type": "integer" }, "lastModifiedTime": { "description": "ISO 8601 timestamp indicating when the EdgeWorker was most recently modified.", "format": "date-time", "type": "string" }, "network": { "description": "The network on which the version is deactivated, either `PRODUCTION` or `STAGING`.", "type": "string", "enum": [ "STAGING", "PRODUCTION" ] }, "note": { "description": "Note to specify why the version is being deactivated.", "minLength": 1, "type": "string" }, "status": { "description": "The deactivation status of the EdgeWorker version, either `PRESUBMIT`, `PENDING`, `IN_PROGRESS`, `COMPLETE`, `ABORTED`, `ERROR`, `DELETED_BY_AKAMAI`, or `EXPIRED`.", "type": "string", "enum": [ "PRESUBMIT", "PENDING", "IN_PROGRESS", "ABORTED", "ERROR", "COMPLETE", "DELETED_BY_AKAMAI", "EXPIRED", "CANCELLED" ] }, "version": { "description": "Unique identifier of the version.", "minLength": 1, "type": "string" } }, "x-akamai": { "file-path": "schemas/deactivation-get-200.yaml" } } } }, "x-akamai": { "file-path": "schemas/deactivations-get-200.yaml" } } } } } }, "parameters": [ { "description": "Unique identifier for a specific EdgeWorker version.", "example": "{{version}}", "in": "query", "name": "version", "schema": { "example": "5", "type": "string" }, "x-akamai": { "file-path": "parameters/version-query.yaml" } }, { "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).", "example": "{{accountSwitchKey}}", "in": "query", "name": "accountSwitchKey", "required": false, "schema": { "example": "1-5C0YLB:1-8BYUX", "type": "string" } } ] }, "parameters": [ { "description": "Unique identifier for an EdgeWorker.", "example": "{{edgeWorkerId}}", "in": "path", "name": "edgeWorkerId", "required": true, "schema": { "example": 42, "minimum": 1, "type": "integer" }, "x-akamai": { "file-path": "parameters/edgeWorkerId-path.yaml" } } ] }, "/ids/{edgeWorkerId}/deactivations/{deactivationId}": { "get": { "description": "View details for a specific deactivation.", "operationId": "get-deactivation", "summary": "Akamai Get a Deactivation", "tags": [ "Deactivations" ], "externalDocs": { "description": "See documentation for this operation in Akamai's EdgeWorkers API", "url": "https://techdocs.akamai.com/edgeworkers/reference/get-deactivation" }, "responses": { "200": { "description": "Provides details for an EdgeWorker deactivation.", "content": { "application/json": { "example": { "accountId": "A-CCT5678", "createdBy": "jsmith", "createdTime": "2020-08-04T11:42:56Z", "deactivationId": 3, "edgeWorkerId": 42, "lastModifiedTime": "2020-08-04T12:00:03Z", "network": "PRODUCTION", "note": "EdgeWorker ID 42 is no longer used in production.", "status": "PENDING", "version": "9" }, "schema": { "additionalProperties": false, "type": "object", "required": [ "edgeWorkerId", "version", "deactivationId", "accountId", "status", "network", "createdBy", "createdTime", "lastModifiedTime" ], "properties": { "accountId": { "description": "Identifier for the account under which the EdgeWorker was created.", "minLength": 1, "type": "string" }, "createdBy": { "description": "Username of the person who created the EdgeWorker.", "minLength": 1, "type": "string" }, "createdTime": { "description": "ISO 8601 timestamp indicating when the EdgeWorker was created.", "format": "date-time", "type": "string" }, "deactivationId": { "description": "Unique identifier of the deactivation.", "minimum": 1, "type": "integer" }, "edgeWorkerId": { "description": "Unique identifier of the EdgeWorker.", "minimum": 1, "type": "integer" }, "lastModifiedTime": { "description": "ISO 8601 timestamp indicating when the EdgeWorker was most recently modified.", "format": "date-time", "type": "string" }, "network": { "description": "The network on which the version is deactivated, either `PRODUCTION` or `STAGING`.", "type": "string", "enum": [ "STAGING", "PRODUCTION" ] }, "note": { "description": "Note to specify why the version is being deactivated.", "minLength": 1, "type": "string" }, "status": { "description": "The deactivation status of the EdgeWorker version, either `PRESUBMIT`, `PENDING`, `IN_PROGRESS`, `COMPLETE`, `ABORTED`, `ERROR`, `DELETED_BY_AKAMAI`, or `EXPIRED`.", "type": "string", "enum": [ "PRESUBMIT", "PENDING", "IN_PROGRESS", "ABORTED", "ERROR", "COMPLETE", "DELETED_BY_AKAMAI", "EXPIRED", "CANCELLED" ] }, "version": { "description": "Unique identifier of the version.", "minLength": 1, "type": "string" } }, "x-akamai": { "file-path": "schemas/deactivation-get-200.yaml" } } } } } }, "parameters": [ { "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).", "example": "{{accountSwitchKey}}", "in": "query", "name": "accountSwitchKey", "required": false, "schema": { "example": "1-5C0YLB:1-8BYUX", "type": "string" } } ] }, "parameters": [ { "description": "Unique identifier for an EdgeWorker deactivation.", "example": "{{deactivationId}}", "in": "path", "name": "deactivationId", "required": true, "schema": { "example": 3, "type": "integer" }, "x-akamai": { "file-path": "parameters/deactivationId-path.yaml" } }, { "description": "Unique identifier for an EdgeWorker.", "example": "{{edgeWorkerId}}", "in": "path", "name": "edgeWorkerId", "required": true, "schema": { "example": 42, "minimum": 1, "type": "integer" }, "x-akamai": { "file-path": "parameters/edgeWorkerId-path.yaml" } } ] }, "/ids/{edgeWorkerId}/properties": { "get": { "description": "View the list of properties using an existing EdgeWorker ID. You can limit the results to active properties.", "operationId": "get-properties", "summary": "Akamai List Properties", "tags": [ "Properties" ], "externalDocs": { "description": "See documentation for this operation in Akamai's EdgeWorkers API", "url": "https://techdocs.akamai.com/edgeworkers/reference/get-properties" }, "responses": { "200": { "description": "This section describes a list of properties.", "content": { "application/json": { "example": { "limitedAccessToProperties": false, "properties": [ { "latestVersion": 147, "productionVersion": null, "propertyId": 4567, "propertyName": "www.customer.com", "stagingVersion": 147 }, { "latestVersion": 56, "productionVersion": 55, "propertyId": 6789, "propertyName": "www.other.customer.com", "stagingVersion": 56 } ] }, "schema": { "additionalProperties": false, "description": "This object collects data about any properties that enable EdgeWorkers.", "type": "object", "required": [ "properties" ], "properties": { "limitedAccessToProperties": { "description": "Whether you have a limited access to properties. Only properties you have access to are listed.", "type": "boolean" }, "properties": { "description": "List of properties.", "minItems": 0, "type": "array", "items": { "additionalProperties": false, "description": "This object collects data about a specific property that enable EdgeWorkers.", "type": "object", "required": [ "propertyId", "propertyName", "stagingVersion", "productionVersion", "latestVersion" ], "properties": { "latestVersion": { "description": "Specifies the most recent version of the property.", "minimum": 1, "type": "integer" }, "productionVersion": { "description": "The most recent version to be activated to the production network, otherwise null.", "minimum": 1, "nullable": true, "type": "integer" }, "propertyId": { "description": "Unique identifier of the property.", "minimum": 1, "type": "integer" }, "propertyName": { "description": "Name of the property.", "minLength": 1, "type": "string" }, "stagingVersion": { "description": "The most recent version to be activated to the test network, otherwise null.", "minimum": 1, "nullable": true, "type": "integer" } }, "x-akamai": { "file-path": "schemas/property-get-200.yaml" } } } }, "x-akamai": { "file-path": "schemas/properties-get-200.yaml" } } } } } }, "parameters": [ { "description": "When enabled, limits results to active properties.", "example": "{{activeOnly}}", "in": "query", "name": "activeOnly", "schema": { "example": true, "type": "boolean" }, "x-akamai": { "file-path": "parameters/activeOnly-query.yaml" } }, { "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).", "example": "{{accountSwitchKey}}", "in": "query", "name": "accountSwitchKey", "required": false, "schema": { "example": "1-5C0YLB:1-8BYUX", "type": "string" } } ] }, "parameters": [ { "description": "Unique identifier for an EdgeWorker.", "example": "{{edgeWorkerId}}", "in": "path", "name": "edgeWorkerId", "required": true, "schema": { "example": 42, "minimum": 1, "type": "integer" }, "x-akamai": { "file-path": "parameters/edgeWorkerId-path.yaml" } } ] }, "/ids/{edgeWorkerId}/resource-tier": { "get": { "description": "View the details of the resource tier assigned to the EdgeWorker ID.", "operationId": "get-id-resource-tier", "summary": "Akamai Get the Resource Tier", "tags": [ "EdgeWorker IDs" ], "externalDocs": { "description": "See documentation for this operation in Akamai's EdgeWorkers API", "url": "https://techdocs.akamai.com/edgeworkers/reference/get-id-resource-tier" }, "responses": { "200": { "description": "The resource tier defines the limits and billing rate applied to an EdgeWorker.", "content": { "application/json": { "example": { "resourceTierId": 200, "resourceTierName": "Dynamic Compute", "edgeWorkerLimits": [ { "limitName": "Maximum CPU time during initialization", "limitUnit": "MILLISECOND", "limitValue": 30 }, { "limitName": "Maximum wall time during initialization", "limitUnit": "MILLISECOND", "limitValue": 100 }, { "limitName": "Maximum number of HTTP sub-requests allowed in parallel per EdgeWorker ID", "limitUnit": "COUNT", "limitValue": 0 }, { "limitName": "Maximum memory usage per event handler", "limitUnit": "BYTE", "limitValue": 1310720 }, { "limitName": "Maximum CPU time per event handler", "limitUnit": "MILLISECOND", "limitValue": 50 }, { "limitName": "Maximum wall time per event handler", "limitUnit": "MILLISECOND", "limitValue": 4000 }, { "limitName": "Maximum number of HTTP sub-requests allowed from a parent request", "limitUnit": "COUNT", "limitValue": 1 }, { "limitName": "Maximum number of HTTP sub-requests allowed in parallel with the parent request", "limitUnit": "COUNT", "limitValue": 1 }, { "limitName": "Maximum wall time per HTTP sub-request", "limitUnit": "MILLISECOND", "limitValue": 1000 }, { "limitName": "Maximum response size per HTTP sub-request", "limitUnit": "BYTE", "limitValue": 1048576 }, { "limitName": "Maximum memory usage for responseProvider", "limitUnit": "BYTE", "limitValue": 2097152 }, { "limitName": "Maximum CPU time for responseProvider", "limitUnit": "MILLISECOND", "limitValue": 100 }, { "limitName": "Maximum wall time for responseProvider", "limitUnit": "MILLISECOND", "limitValue": 4000 }, { "limitName": "Maximum number of HTTP sub-requests allowed for responseProvider", "limitUnit": "COUNT", "limitValue": 50 }, { "limitName": "Maximum number of HTTP sub-requests allowed in parallel for responseProvider", "limitUnit": "COUNT", "limitValue": 5 }, { "limitName": "Maximum walltime for HTTP sub-requests during the execution of the responseProvider event handler", "limitUnit": "MILLISECOND", "limitValue": 1000 }, { "limitName": "Maximum response size for HTTP sub-requests during the responseProvider event handler", "limitUnit": "BYTE", "limitValue": 1048576 } ] }, "schema": { "additionalProperties": false, "type": "object", "required": [ "resourceTierId", "resourceTierName", "edgeWorkerLimits" ], "properties": { "edgeWorkerLimits": { "description": "List of EdgeWorker limits.", "minItems": 1, "type": "array", "items": { "additionalProperties": false, "description": "Provides details for an EdgeWorker limit.", "type": "object", "required": [ "limitName", "limitValue" ], "properties": { "limitName": { "description": "Name of the limit.", "minLength": 1, "readOnly": true, "type": "string" }, "limitUnit": { "description": "Unit of the limit, either `BYTE`, `MILLISECOND`, or `COUNT`.", "readOnly": true, "type": "string", "enum": [ "BYTE", "MILLISECOND", "COUNT" ] }, "limitValue": { "description": "Value of the limit.", "minimum": 0, "readOnly": true, "type": "integer" } }, "x-akamai": { "file-path": "schemas/ew-limit.yaml" } } }, "resourceTierId": { "description": "Unique identifier of the resource tier.", "minimum": 1, "type": "integer" }, "resourceTierName": { "description": "Name of the resource tier.", "minLength": 1, "type": "string" } }, "x-akamai": { "file-path": "schemas/resource-tier-get-200.yaml" } } } } } }, "parameters": [ { "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).", "example": "{{accountSwitchKey}}", "in": "query", "name": "accountSwitchKey", "required": false, "schema": { "example": "1-5C0YLB:1-8BYUX", "type": "string" } } ] }, "parameters": [ { "description": "Unique identifier for an EdgeWorker.", "example": "{{edgeWorkerId}}", "in": "path", "name": "edgeWorkerId", "required": true, "schema": { "example": 42, "minimum": 1, "type": "integer" }, "x-akamai": { "file-path": "parameters/edgeWorkerId-path.yaml" } } ] }, "/ids/{edgeWorkerId}/revisions": { "get": { "description": "__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).", "operationId": "get-revisions", "summary": "Akamai List Revisions", "tags": [ "Revisions" ], "externalDocs": { "description": "See documentation for this operation in Akamai's EdgeWorkers API", "url": "https://techdocs.akamai.com/edgeworkers/reference/get-revisions" }, "responses": { "200": { "description": "This section describes a list of EdgeWorker revisions.", "content": { "application/json": { "example": { "revisions": [ { "accountId": "A-CCT3456", "activationId": 1, "checksum": "db3697e7eb03c8fb4822fd763b840e1b915693ab03e02a583fecfcd55d07857d", "createdTime": "2023-08-10T15:32:22Z", "edgeWorkerId": 42, "lastModifiedTime": "2023-08-10T15:41:20Z", "network": "PRODUCTION", "revisionActivationStatus": "COMPLETE", "revisionId": "1-2", "version": "0.7" }, { "accountId": "A-CCT5678", "activationId": 1, "checksum": "a89dfc162fa3d81d36f40805620cb21be6de5d869374e71feda1afff17dae2a7", "createdTime": "2023-08-10T15:22:45Z", "edgeWorkerId": 42, "lastModifiedTime": "2023-08-10T15:27:01Z", "network": "PRODUCTION", "revisionActivationStatus": "COMPLETE", "revisionId": "1-1", "version": "0.7" } ] }, "schema": { "additionalProperties": false, "type": "object", "required": [ "revisions" ], "properties": { "revisions": { "description": "List of EdgeWorker revisions.", "minItems": 0, "type": "array", "items": { "additionalProperties": false, "type": "object", "required": [ "edgeWorkerId", "version", "activationId", "revisionId", "accountId", "checksum", "revisionActivationStatus", "network", "createdTime", "lastModifiedTime" ], "properties": { "accountId": { "description": "Identifier for the account under which the EdgeWorker was created.", "minLength": 1, "type": "string" }, "activationId": { "description": "Unique identifier of the activation.", "minimum": 1, "type": "integer" }, "createdTime": { "description": "ISO 8601 timestamp indicating when the revision was created.", "format": "date-time", "type": "string" }, "edgeWorkerId": { "description": "Unique identifier of the EdgeWorker.", "minimum": 1, "type": "integer" }, "lastModifiedTime": { "description": "ISO 8601 timestamp indicating when the revision was most recently modified.", "format": "date-time", "type": "string" }, "network": { "description": "The network on which the revision is activated, either `PRODUCTION` or `STAGING`.", "type": "string", "enum": [ "STAGING", "PRODUCTION" ] }, "note": { "description": "Note to explain why you're reactivating the revision.", "maxLength": 128, "minLength": 1, "type": "string" }, "revisionActivatedBy": { "description": "Username of the person who reactivated the revision.", "minLength": 1, "type": "string" }, "revisionActivatedTime": { "description": "ISO 8601 timestamp indicating when the revision was most recently reactivated.", "format": "date-time", "type": "string" }, "revisionActivationStatus": { "description": "The activation status of the EdgeWorker revision, either `PRESUBMIT`, `PENDING`, `IN_PROGRESS`, `COMPLETE`, `CANCELLED`, `ABORTED`, `ERROR`, `DELETED_BY_AKAMAI`, `EXPIRED`, or `INVALID_COMBINED_BUNDLE`.", "type": "string", "enum": [ "PRESUBMIT", "PENDING", "IN_PROGRESS", "ABORTED", "ERROR", "COMPLETE", "DELETED_BY_AKAMAI", "EXPIRED", "CANCELLED", "INVALID_COMBINED_BUNDLE" ] }, "revisionId": { "description": "Unique identifier of the revision.", "minLength": 1, "type": "string" }, "validation": { "additionalProperties": false, "description": "Validation result included if the revision activation status is `INVALID_COMBINED_BUNDLE`.", "type": "object", "required": [ "errors" ], "properties": { "errors": { "description": "List of validation errors.", "minItems": 1, "type": "array", "items": { "additionalProperties": false, "description": "Provides details for an EdgeWorker code bundle validation error.", "type": "object", "required": [ "type", "message" ], "properties": { "message": { "description": "Message containing more details about the validation error.", "minLength": 1, "readOnly": true, "type": "string" }, "type": { "description": "The type of the validation error. See [Validation error types](https://techdocs.akamai.com/edgeworkers/reference/validation-types).", "readOnly": true, "type": "string", "enum": [ "ACCESS_TOKEN_EXPIRED", "ACCESS_TOKEN_INVALID", "ACCESS_TOKEN_MISSING", "EDGEKV_FILE_MISSING", "EDGEKV_TOKENS_FILE_MISSING", "EMPTY_TARBALL", "INVALID_EDGEKV_IMPORTS", "INVALID_GZIP_FORMAT", "INVALID_MANIFEST", "INVALID_TAR_ARCHIVE", "MAX_COMPRESSED_SIZE_EXCEEDED", "MAX_UNCOMPRESSED_SIZE_EXCEEDED", "MISSING_MANDATORY_FILES", "STATIC_VALIDATION_FAILED", "DEPENDENCY_NOT_FOUND", "MISSING_MEGABUNDLE_JSON_FILE", "MISSING_DEPENDENCIES_DIRECTORY", "INVALID_MEGABUNDLE_JSON_FILE" ] } }, "x-akamai": { "file-path": "schemas/validation-error.yaml" } } } } }, "version": { "description": "Unique identifier of the version.", "minLength": 1, "type": "string" } }, "x-akamai": { "file-path": "schemas/revision-get-200.yaml" } } } }, "x-akamai": { "file-path": "schemas/revisions-get-200.yaml" } } } } } }, "x-akamai": { "status": "BETA" }, "parameters": [ { "description": "Unique identifier for a specific EdgeWorker version.", "example": "{{version}}", "in": "query", "name": "version", "schema": { "example": "5", "type": "string" }, "x-akamai": { "file-path": "parameters/version-query.yaml" } }, { "description": "Filters results to a specific activation.", "example": "{{activationId}}", "in": "query", "name": "activationId", "schema": { "example": 3, "minimum": 1, "type": "integer" }, "x-akamai": { "file-path": "parameters/activationId-query.yaml" } }, { "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.", "example": "{{network}}", "in": "query", "name": "network", "schema": { "example": "STAGING", "type": "string", "enum": [ "STAGING", "PRODUCTION" ] }, "x-akamai": { "file-path": "parameters/network-query.yaml" } }, { "description": "When enabled, limits results to show only currently or previously pinned revisions.", "example": "{{pinnedOnly}}", "in": "query", "name": "pinnedOnly", "schema": { "example": true, "type": "boolean" }, "x-akamai": { "file-path": "parameters/pinnedOnly-query.yaml" } }, { "description": "When enabled, limits results to show only revisions that are currently pinned.", "example": "{{currentlyPinned}}", "in": "query", "name": "currentlyPinned", "schema": { "example": true, "type": "boolean" }, "x-akamai": { "file-path": "parameters/currentlyPinned-query.yaml" } }, { "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).", "example": "{{accountSwitchKey}}", "in": "query", "name": "accountSwitchKey", "required": false, "schema": { "example": "1-5C0YLB:1-8BYUX", "type": "string" } } ] }, "parameters": [ { "description": "Unique identifier for an EdgeWorker.", "example": "{{edgeWorkerId}}", "in": "path", "name": "edgeWorkerId", "required": true, "schema": { "example": 42, "minimum": 1, "type": "integer" }, "x-akamai": { "file-path": "parameters/edgeWorkerId-path.yaml" } } ] }, "/ids/{edgeWorkerId}/revisions/activations": { "post": { "description": "__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).", "operationId": "post-revision-activations", "summary": "Akamai Activate a Fallback Revision", "tags": [ "Revisions" ], "externalDocs": { "description": "See documentation for this operation in Akamai's EdgeWorkers API", "url": "https://techdocs.akamai.com/edgeworkers/reference/post-revision-activations" }, "requestBody": { "required": true, "content": { "application/json": { "example": { "revisionId": "5-1" }, "schema": { "additionalProperties": false, "type": "object", "required": [ "revisionId" ], "properties": { "note": { "description": "Note to specify why the revision is being reactivated.", "example": "{{note}}", "maxLength": 128, "minLength": 1, "type": "string" }, "revisionId": { "description": "Unique identifier of the revision.", "example": "{{revisionId}}", "minLength": 1, "type": "string" } }, "x-akamai": { "file-path": "schemas/revision-activations-post.yaml" } } } } }, "responses": { "200": { "description": "Provides details for the revision activation.", "content": { "application/json": { "example": { "accountId": "A-CCT7890", "activationId": 5, "createdBy": "jsmith", "createdTime": "2023-08-14T17:17:43Z", "edgeWorkerId": 42, "lastModifiedTime": "2023-08-14T17:17:43Z", "network": "STAGING", "revisionId": "5-1", "status": "PRESUBMIT", "version": "0.4" }, "schema": { "additionalProperties": false, "type": "object", "required": [ "edgeWorkerId", "version", "activationId", "revisionId", "accountId", "status", "network", "createdBy", "createdTime", "lastModifiedTime" ], "properties": { "accountId": { "description": "Identifier for the account under which the EdgeWorker was created.", "minLength": 1, "type": "string" }, "activationId": { "description": "Unique identifier of the activation.", "minimum": 1, "type": "integer" }, "createdBy": { "description": "Username of the person who activated the revision.", "minLength": 1, "type": "string" }, "createdTime": { "description": "ISO 8601 timestamp indicating when the revision was created.", "format": "date-time", "type": "string" }, "edgeWorkerId": { "description": "Unique identifier of the EdgeWorker.", "minimum": 1, "type": "integer" }, "lastModifiedTime": { "description": "ISO 8601 timestamp indicating when the revision was most recently modified.", "format": "date-time", "type": "string" }, "network": { "description": "The network on which the revision is activated, either `PRODUCTION` or `STAGING`.", "type": "string", "enum": [ "STAGING", "PRODUCTION" ] }, "note": { "description": "Note to explain why you're reactivating the revision.", "maxLength": 128, "minLength": 1, "type": "string" }, "revisionId": { "description": "Unique identifier of the revision.", "minLength": 1, "type": "string" }, "status": { "description": "The activation status of the EdgeWorker revision, either `PRESUBMIT`, `PENDING`, `IN_PROGRESS`, `COMPLETE`, `CANCELLED`, `ABORTED`, `ERROR`, `DELETED_BY_AKAMAI`, `EXPIRED`, or `INVALID_COMBINED_BUNDLE`.", "type": "string", "enum": [ "PRESUBMIT", "PENDING", "IN_PROGRESS", "ABORTED", "ERROR", "COMPLETE", "DELETED_BY_AKAMAI", "EXPIRED", "CANCELLED", "INVALID_COMBINED_BUNDLE" ] }, "version": { "description": "Unique identifier of the version.", "minLength": 1, "type": "string" } }, "x-akamai": { "file-path": "schemas/revision-activations-post-200.yaml" } } } } } }, "x-akamai": { "status": "BETA" }, "parameters": [ { "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).", "example": "{{accountSwitchKey}}", "in": "query", "name": "accountSwitchKey", "required": false, "schema": { "example": "1-5C0YLB:1-8BYUX", "type": "string" } } ] }, "get": { "description": "__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).", "operationId": "get-revision-activations", "summary": "Akamai List Revision Activations", "tags": [ "Revisions" ], "externalDocs": { "description": "See documentation for this operation in Akamai's EdgeWorkers API", "url": "https://techdocs.akamai.com/edgeworkers/reference/get-revision-activations" }, "responses": { "200": { "description": "The response lists EdgeWorker revision activations.", "content": { "application/json": { "example": { "revisionActivations": [ { "accountId": "A-CCT9012", "activationId": 5, "createdTime": "2023-08-18T23:19:01Z", "edgeWorkerId": 42, "lastModifiedTime": "2023-08-18T23:22:01Z", "network": "STAGING", "revisionId": "5-2", "status": "COMPLETE", "version": "0.4" }, { "accountId": "A-CCT9012", "activationId": 5, "createdBy": "jsmith", "createdTime": "2023-07-14T17:17:43Z", "edgeWorkerId": 42, "lastModifiedTime": "2023-07-14T17:20:09Z", "network": "STAGING", "revisionId": "5-1", "status": "COMPLETE", "version": "0.4" }, { "accountId": "A-CCT1234", "activationId": 4, "createdTime": "2023-07-13T19:06:40Z", "edgeWorkerId": 42, "lastModifiedTime": "2023-07-13T19:09:01Z", "network": "STAGING", "revisionId": "4-1", "status": "COMPLETE", "version": "0.4" } ] }, "schema": { "additionalProperties": false, "type": "object", "required": [ "edgeWorkerId", "version", "activationId", "revisionId", "accountId", "status", "network", "createdTime", "lastModifiedTime" ], "properties": { "accountId": { "description": "Identifier for the account under which the EdgeWorker was created.", "minLength": 1, "type": "string" }, "activationId": { "description": "Unique identifier of the activation.", "minimum": 1, "type": "integer" }, "createdBy": { "description": "Username of the person who activated the revision.", "minLength": 1, "type": "string" }, "createdTime": { "description": "ISO 8601 timestamp indicating when the revision was created.", "format": "date-time", "type": "string" }, "edgeWorkerId": { "description": "Unique identifier of the EdgeWorker.", "minimum": 1, "type": "integer" }, "lastModifiedTime": { "description": "ISO 8601 timestamp indicating when the revision was most recently modified.", "format": "date-time", "type": "string" }, "network": { "description": "The network on which the revision is activated, either `PRODUCTION` or `STAGING`.", "type": "string", "enum": [ "STAGING", "PRODUCTION" ] }, "note": { "description": "Note to explain why you're reactivating the revision.", "maxLength": 128, "minLength": 1, "type": "string" }, "revisionId": { "description": "Unique identifier of the revision.", "minLength": 1, "type": "string" }, "status": { "description": "The activation status of the EdgeWorker revision, either `PRESUBMIT`, `PENDING`, `IN_PROGRESS`, `COMPLETE`, `CANCELLED`, `ABORTED`, `ERROR`, `DELETED_BY_AKAMAI`, `EXPIRED`, or `INVALID_COMBINED_BUNDLE`.", "type": "string", "enum": [ "PRESUBMIT", "PENDING", "IN_PROGRESS", "ABORTED", "ERROR", "COMPLETE", "DELETED_BY_AKAMAI", "EXPIRED", "CANCELLED", "INVALID_COMBINED_BUNDLE" ] }, "version": { "description": "Unique identifier of the version.", "minLength": 1, "type": "string" } }, "x-akamai": { "file-path": "schemas/revision-activations-get-200.yaml" } } } } } }, "x-akamai": { "status": "BETA" }, "parameters": [ { "description": "Unique identifier for a specific EdgeWorker version.", "example": "{{version}}", "in": "query", "name": "version", "schema": { "example": "5", "type": "string" }, "x-akamai": { "file-path": "parameters/version-query.yaml" } }, { "description": "Filters results to a specific activation.", "example": "{{activationId}}", "in": "query", "name": "activationId", "schema": { "example": 3, "minimum": 1, "type": "integer" }, "x-akamai": { "file-path": "parameters/activationId-query.yaml" } }, { "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.", "example": "{{network}}", "in": "query", "name": "network", "schema": { "example": "STAGING", "type": "string", "enum": [ "STAGING", "PRODUCTION" ] }, "x-akamai": { "file-path": "parameters/network-query.yaml" } }, { "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).", "example": "{{accountSwitchKey}}", "in": "query", "name": "accountSwitchKey", "required": false, "schema": { "example": "1-5C0YLB:1-8BYUX", "type": "string" } } ] }, "parameters": [ { "description": "Unique identifier for an EdgeWorker.", "example": "{{edgeWorkerId}}", "in": "path", "name": "edgeWorkerId", "required": true, "schema": { "example": 42, "minimum": 1, "type": "integer" }, "x-akamai": { "file-path": "parameters/edgeWorkerId-path.yaml" } } ] }, "/ids/{edgeWorkerId}/revisions/{revisionId}": { "get": { "description": "__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).", "operationId": "get-revision", "summary": "Akamai Get a Revision", "tags": [ "Revisions" ], "externalDocs": { "description": "See documentation for this operation in Akamai's EdgeWorkers API", "url": "https://techdocs.akamai.com/edgeworkers/reference/get-revision" }, "responses": { "200": { "description": "Provides details for an EdgeWorker revision.", "content": { "application/json": { "example": { "accountId": "A-CCT1234", "activationId": 1, "checksum": "db3697e7eb03c8fb4822fd763b840e1b915693ab03e02a583fecfcd55d07857d", "createdTime": "2023-08-10T15:32:22Z", "edgeWorkerId": 42, "lastModifiedTime": "2023-08-10T15:41:20Z", "network": "PRODUCTION", "revisionActivationStatus": "COMPLETE", "revisionId": "1-2", "version": "0.7" }, "schema": { "additionalProperties": false, "type": "object", "required": [ "edgeWorkerId", "version", "activationId", "revisionId", "accountId", "checksum", "revisionActivationStatus", "network", "createdTime", "lastModifiedTime" ], "properties": { "accountId": { "description": "Identifier for the account under which the EdgeWorker was created.", "minLength": 1, "type": "string" }, "activationId": { "description": "Unique identifier of the activation.", "minimum": 1, "type": "integer" }, "createdTime": { "description": "ISO 8601 timestamp indicating when the revision was created.", "format": "date-time", "type": "string" }, "edgeWorkerId": { "description": "Unique identifier of the EdgeWorker.", "minimum": 1, "type": "integer" }, "lastModifiedTime": { "description": "ISO 8601 timestamp indicating when the revision was most recently modified.", "format": "date-time", "type": "string" }, "network": { "description": "The network on which the revision is activated, either `PRODUCTION` or `STAGING`.", "type": "string", "enum": [ "STAGING", "PRODUCTION" ] }, "note": { "description": "Note to explain why you're reactivating the revision.", "maxLength": 128, "minLength": 1, "type": "string" }, "revisionActivatedBy": { "description": "Username of the person who reactivated the revision.", "minLength": 1, "type": "string" }, "revisionActivatedTime": { "description": "ISO 8601 timestamp indicating when the revision was most recently reactivated.", "format": "date-time", "type": "string" }, "revisionActivationStatus": { "description": "The activation status of the EdgeWorker revision, either `PRESUBMIT`, `PENDING`, `IN_PROGRESS`, `COMPLETE`, `CANCELLED`, `ABORTED`, `ERROR`, `DELETED_BY_AKAMAI`, `EXPIRED`, or `INVALID_COMBINED_BUNDLE`.", "type": "string", "enum": [ "PRESUBMIT", "PENDING", "IN_PROGRESS", "ABORTED", "ERROR", "COMPLETE", "DELETED_BY_AKAMAI", "EXPIRED", "CANCELLED", "INVALID_COMBINED_BUNDLE" ] }, "revisionId": { "description": "Unique identifier of the revision.", "minLength": 1, "type": "string" }, "validation": { "additionalProperties": false, "description": "Validation result included if the revision activation status is `INVALID_COMBINED_BUNDLE`.", "type": "object", "required": [ "errors" ], "properties": { "errors": { "description": "List of validation errors.", "minItems": 1, "type": "array", "items": { "additionalProperties": false, "description": "Provides details for an EdgeWorker code bundle validation error.", "type": "object", "required": [ "type", "message" ], "properties": { "message": { "description": "Message containing more details about the validation error.", "minLength": 1, "readOnly": true, "type": "string" }, "type": { "description": "The type of the validation error. See [Validation error types](https://techdocs.akamai.com/edgeworkers/reference/validation-types).", "readOnly": true, "type": "string", "enum": [ "ACCESS_TOKEN_EXPIRED", "ACCESS_TOKEN_INVALID", "ACCESS_TOKEN_MISSING", "EDGEKV_FILE_MISSING", "EDGEKV_TOKENS_FILE_MISSING", "EMPTY_TARBALL", "INVALID_EDGEKV_IMPORTS", "INVALID_GZIP_FORMAT", "INVALID_MANIFEST", "INVALID_TAR_ARCHIVE", "MAX_COMPRESSED_SIZE_EXCEEDED", "MAX_UNCOMPRESSED_SIZE_EXCEEDED", "MISSING_MANDATORY_FILES", "STATIC_VALIDATION_FAILED", "DEPENDENCY_NOT_FOUND", "MISSING_MEGABUNDLE_JSON_FILE", "MISSING_DEPENDENCIES_DIRECTORY", "INVALID_MEGABUNDLE_JSON_FILE" ] } }, "x-akamai": { "file-path": "schemas/validation-error.yaml" } } } } }, "version": { "description": "Unique identifier of the version.", "minLength": 1, "type": "string" } }, "x-akamai": { "file-path": "schemas/revision-get-200.yaml" } } } } } }, "x-akamai": { "status": "BETA" }, "parameters": [ { "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).", "example": "{{accountSwitchKey}}", "in": "query", "name": "accountSwitchKey", "required": false, "schema": { "example": "1-5C0YLB:1-8BYUX", "type": "string" } } ] }, "parameters": [ { "description": "Unique identifier for an EdgeWorkers revision.", "example": "{{revisionId}}", "in": "path", "name": "revisionId", "required": true, "schema": { "example": "3-1", "type": "string" }, "x-akamai": { "file-path": "parameters/revisionId-path.yaml" } }, { "description": "Unique identifier for an EdgeWorker.", "example": "{{edgeWorkerId}}", "in": "path", "name": "edgeWorkerId", "required": true, "schema": { "example": 42, "minimum": 1, "type": "integer" }, "x-akamai": { "file-path": "parameters/edgeWorkerId-path.yaml" } } ] }, "/ids/{edgeWorkerId}/revisions/{revisionId}/bom": { "get": { "description": "__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).", "operationId": "get-revision-bom", "summary": "Akamai Get a Revision BOM", "tags": [ "Revisions" ], "externalDocs": { "description": "See documentation for this operation in Akamai's EdgeWorkers API", "url": "https://techdocs.akamai.com/edgeworkers/reference/get-revision-bom" }, "responses": { "200": { "description": "Provides the Bill of Materials for an EdgeWorker revision.", "content": { "application/json": { "example": { "edgeWorkerId": 42, "version": "0.7", "dependencies": { "redirect-geo-query": { "edgeWorkerId": 23, "version": "4.0", "dependencies": {} } } }, "schema": { "additionalProperties": false, "type": "object", "required": [ "edgeWorkerId", "version", "dependencies" ], "properties": { "activeVersion": { "description": "Unique identifier for the active version.", "minLength": 1, "type": "string" }, "dependencies": { "additionalProperties": false, "description": "EdgeWorker dependencies.", "minProperties": 0, "type": "object", "required": [ "edgeWorkerId", "version", "dependencies" ], "properties": { "activeVersion": { "description": "Unique identifier for the active version.", "minLength": 1, "type": "string" }, "dependencies": { "description": "EdgeWorker dependencies. This is a further nested revision BOM object.", "minProperties": 0, "type": "object" }, "edgeWorkerId": { "description": "Unique identifier of the EdgeWorker.", "minimum": 1, "type": "integer" }, "pinNote": { "description": "Note for the pinned revision.", "maxLength": 128, "minLength": 1, "type": "string" }, "pinnedRevisionId": { "description": "Unique identifier of the pinned revision.", "minLength": 1, "type": "string" }, "pinnedTime": { "description": "ISO 8601 timestamp indicating when the revision was pinned.", "format": "date-time", "type": "string" }, "version": { "description": "Unique identifier of the version.", "minLength": 1, "type": "string" } } }, "edgeWorkerId": { "description": "Unique identifier of the EdgeWorker.", "minimum": 1, "type": "integer" }, "pinNote": { "description": "Note for the pinned revision.", "maxLength": 128, "minLength": 1, "type": "string" }, "pinnedRevisionId": { "description": "Unique identifier of the pinned revision.", "minLength": 1, "type": "string" }, "pinnedTime": { "description": "ISO 8601 timestamp indicating when the revision was pinned.", "format": "date-time", "type": "string" }, "version": { "description": "Unique identifier of the version.", "minLength": 1, "type": "string" } }, "x-akamai": { "file-path": "schemas/revision-bom-get-200.yaml" } } } } } }, "x-akamai": { "status": "BETA" }, "parameters": [ { "description": "When enabled, limits results to show only active versions.", "example": "{{includeActiveVersions}}", "in": "query", "name": "includeActiveVersions", "schema": { "example": true, "type": "boolean" }, "x-akamai": { "file-path": "parameters/includeActiveVersions-query.yaml" } }, { "description": "When enabled, limits results to show only the pinned revisions when the BOM was created.", "example": "{{includePinnedRevisions}}", "in": "query", "name": "includePinnedRevisions", "schema": { "example": true, "type": "boolean" }, "x-akamai": { "file-path": "parameters/includePinnedRevisions-query.yaml" } }, { "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).", "example": "{{accountSwitchKey}}", "in": "query", "name": "accountSwitchKey", "required": false, "schema": { "example": "1-5C0YLB:1-8BYUX", "type": "string" } } ] }, "parameters": [ { "description": "Unique identifier for an EdgeWorkers revision.", "example": "{{revisionId}}", "in": "path", "name": "revisionId", "required": true, "schema": { "example": "3-1", "type": "string" }, "x-akamai": { "file-path": "parameters/revisionId-path.yaml" } }, { "description": "Unique identifier for an EdgeWorker.", "example": "{{edgeWorkerId}}", "in": "path", "name": "edgeWorkerId", "required": true, "schema": { "example": 42, "minimum": 1, "type": "integer" }, "x-akamai": { "file-path": "parameters/edgeWorkerId-path.yaml" } } ] }, "/ids/{edgeWorkerId}/revisions/{revisionId}/compare": { "post": { "description": "__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).", "operationId": "post-revision-compare", "summary": "Akamai Compare Revisions", "tags": [ "Revisions" ], "externalDocs": { "description": "See documentation for this operation in Akamai's EdgeWorkers API", "url": "https://techdocs.akamai.com/edgeworkers/reference/post-revision-compare" }, "requestBody": { "required": true, "content": { "application/json": { "example": { "revisionId": "5-1" }, "schema": { "additionalProperties": false, "type": "object", "required": [ "revisionId" ], "properties": { "revisionId": { "description": "Unique identifier of the revision.", "example": "{{revisionId}}", "minLength": 1, "type": "string" } }, "x-akamai": { "file-path": "schemas/revision-compare-post.yaml" } } } } }, "responses": { "200": { "description": "Provides dependency differences between two revisions.", "content": { "application/json": { "example": { "edgeWorkerId": 42, "version": "0.7", "dependencies": { "redirect-geo-query": { "diff": "UPDATED", "edgeWorkerId": 23, "previousVersion": "3.9", "version": "4.0" } } }, "schema": { "additionalProperties": false, "type": "object", "required": [ "edgeWorkerId", "version", "dependencies" ], "properties": { "dependencies": { "additionalProperties": false, "description": "EdgeWorker dependencies.", "minProperties": 0, "type": "object", "required": [ "edgeWorkerId", "version", "dependencies" ], "properties": { "dependencies": { "description": "EdgeWorker dependencies. This is a further nested revision compare object.", "minProperties": 0, "type": "object" }, "edgeWorkerId": { "description": "Unique identifier of the EdgeWorker.", "minimum": 1, "type": "integer" }, "previousVersion": { "description": "Unique identifier of the previous version.", "minLength": 1, "type": "string" }, "version": { "description": "Unique identifier of the version.", "minLength": 1, "type": "string" } } }, "edgeWorkerId": { "description": "Unique identifier of the EdgeWorker.", "minimum": 1, "type": "integer" }, "previousVersion": { "description": "Unique identifier of the previous version.", "minLength": 1, "type": "string" }, "version": { "description": "Unique identifier of the version.", "minLength": 1, "type": "string" } }, "x-akamai": { "file-path": "schemas/revision-compare-post-200.yaml" } } } } } }, "x-akamai": { "status": "BETA" }, "parameters": [ { "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).", "example": "{{accountSwitchKey}}", "in": "query", "name": "accountSwitchKey", "required": false, "schema": { "example": "1-5C0YLB:1-8BYUX", "type": "string" } } ] }, "parameters": [ { "description": "Unique identifier for an EdgeWorkers revision.", "example": "{{revisionId}}", "in": "path", "name": "revisionId", "required": true, "schema": { "example": "3-1", "type": "string" }, "x-akamai": { "file-path": "parameters/revisionId-path.yaml" } }, { "description": "Unique identifier for an EdgeWorker.", "example": "{{edgeWorkerId}}", "in": "path", "name": "edgeWorkerId", "required": true, "schema": { "example": 42, "minimum": 1, "type": "integer" }, "x-akamai": { "file-path": "parameters/edgeWorkerId-path.yaml" } } ] }, "/ids/{edgeWorkerId}/revisions/{revisionId}/content": { "get": { "description": "__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).", "operationId": "get-revision-content", "summary": "Akamai Download the Combined Code Bundle", "tags": [ "Revisions" ], "externalDocs": { "description": "See documentation for this operation in Akamai's EdgeWorkers API", "url": "https://techdocs.akamai.com/edgeworkers/reference/get-revision-content" }, "responses": { "200": { "description": "Downloaded combined code bundle for the revision.", "content": { "application/gzip": { "schema": { "format": "binary", "type": "string" } } } } }, "x-akamai": { "status": "BETA" }, "parameters": [ { "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).", "example": "{{accountSwitchKey}}", "in": "query", "name": "accountSwitchKey", "required": false, "schema": { "example": "1-5C0YLB:1-8BYUX", "type": "string" } } ] }, "parameters": [ { "description": "Unique identifier for an EdgeWorkers revision.", "example": "{{revisionId}}", "in": "path", "name": "revisionId", "required": true, "schema": { "example": "3-1", "type": "string" }, "x-akamai": { "file-path": "parameters/revisionId-path.yaml" } }, { "description": "Unique identifier for an EdgeWorker.", "example": "{{edgeWorkerId}}", "in": "path", "name": "edgeWorkerId", "required": true, "schema": { "example": 42, "minimum": 1, "type": "integer" }, "x-akamai": { "file-path": "parameters/edgeWorkerId-path.yaml" } } ] }, "/ids/{edgeWorkerId}/revisions/{revisionId}/pin": { "post": { "description": "__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).", "operationId": "post-revision-pin", "summary": "Akamai Pin an Active Revision", "tags": [ "Revisions" ], "externalDocs": { "description": "See documentation for this operation in Akamai's EdgeWorkers API", "url": "https://techdocs.akamai.com/edgeworkers/reference/post-revision-pin" }, "requestBody": { "required": true, "content": { "application/json": { "example": { "pinNote": "Disable dynamic activation during moratorium" }, "schema": { "additionalProperties": false, "type": "object", "properties": { "pinNote": { "description": "Note to specify why the revision is being pinned.", "example": "{{pinNote}}", "maxLength": 128, "minLength": 1, "type": "string" } }, "x-akamai": { "file-path": "schemas/revision-pin-post.yaml" } } } } }, "responses": { "200": { "description": "Provides details for the pinned EdgeWorker revision.", "content": { "application/json": { "example": { "accountId": "A-CCT9012", "activationId": 5, "checksum": "70f76db1a24a40fb194f69ef3d5d557abb11cd88f7fce035a1d21385daf50b6d", "createdTime": "2023-07-13T19:20:01Z", "edgeWorkerId": 42, "lastModifiedTime": "2023-08-14T17:20:09Z", "network": "STAGING", "pinNote": "Disable dynamic reactivation during moratorium", "pinnedBy": "jsmith", "pinnedTime": "2023-08-14T17:17:43Z", "revisionActivatedBy": "jsmith", "revisionActivatedTime": "2023-08-14T17:17:43Z", "revisionActivationStatus": "COMPLETE", "revisionId": "5-1", "version": "0.4" }, "schema": { "additionalProperties": false, "type": "object", "required": [ "edgeWorkerId", "version", "activationId", "revisionId", "accountId", "checksum", "revisionActivationStatus", "network", "createdTime", "lastModifiedTime", "pinnedBy", "pinnedTime" ], "properties": { "accountId": { "description": "Identifier for the account under which the EdgeWorker was created.", "minLength": 1, "type": "string" }, "activationId": { "description": "Unique identifier of the activation.", "minimum": 1, "type": "integer" }, "createdTime": { "description": "ISO 8601 timestamp indicating when the revision was created.", "format": "date-time", "type": "string" }, "edgeWorkerId": { "description": "Unique identifier of the EdgeWorker.", "minimum": 1, "type": "integer" }, "lastModifiedTime": { "description": "ISO 8601 timestamp indicating when the revision was most recently modified.", "format": "date-time", "type": "string" }, "network": { "description": "The network on which the revision is activated, either `PRODUCTION` or `STAGING`.", "type": "string", "enum": [ "STAGING", "PRODUCTION" ] }, "note": { "description": "Note to explain why you're reactivating the revision.", "maxLength": 128, "minLength": 1, "type": "string" }, "pinNote": { "description": "Note to explain why you're pinning the revision.", "maxLength": 128, "minLength": 1, "type": "string" }, "pinnedBy": { "description": "Username of the person who pinned the revision.", "minLength": 1, "type": "string" }, "pinnedTime": { "description": "ISO 8601 timestamp indicating when the revision was pinned.", "format": "date-time", "type": "string" }, "revisionActivatedBy": { "description": "Username of the person who reactivated the revision.", "minLength": 1, "type": "string" }, "revisionActivatedTime": { "description": "ISO 8601 timestamp indicating when the revision was most recently reactivated.", "format": "date-time", "type": "string" }, "revisionActivationStatus": { "description": "The activation status of the EdgeWorker revision, either `PRESUBMIT`, `PENDING`, `IN_PROGRESS`, `COMPLETE`, `CANCELLED`, `ABORTED`, `ERROR`, `DELETED_BY_AKAMAI`, `EXPIRED`, or `INVALID_COMBINED_BUNDLE`.", "type": "string", "enum": [ "PRESUBMIT", "PENDING", "IN_PROGRESS", "ABORTED", "ERROR", "COMPLETE", "DELETED_BY_AKAMAI", "EXPIRED", "CANCELLED", "INVALID_COMBINED_BUNDLE" ] }, "revisionId": { "description": "Unique identifier of the revision.", "minLength": 1, "type": "string" }, "unpinnedBy": { "description": "Username of the person who unpinned the revision.", "minLength": 1, "type": "string" }, "version": { "description": "Unique identifier of the version.", "minLength": 1, "type": "string" } }, "x-akamai": { "file-path": "schemas/revision-pin-post-200.yaml" } } } } } }, "x-akamai": { "status": "BETA" }, "parameters": [ { "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).", "example": "{{accountSwitchKey}}", "in": "query", "name": "accountSwitchKey", "required": false, "schema": { "example": "1-5C0YLB:1-8BYUX", "type": "string" } } ] }, "parameters": [ { "description": "Unique identifier for an EdgeWorker.", "example": "{{edgeWorkerId}}", "in": "path", "name": "edgeWorkerId", "required": true, "schema": { "example": 42, "minimum": 1, "type": "integer" }, "x-akamai": { "file-path": "parameters/edgeWorkerId-path.yaml" } }, { "description": "Unique identifier for an EdgeWorkers revision.", "example": "{{revisionId}}", "in": "path", "name": "revisionId", "required": true, "schema": { "example": "3-1", "type": "string" }, "x-akamai": { "file-path": "parameters/revisionId-path.yaml" } } ] }, "/ids/{edgeWorkerId}/revisions/{revisionId}/unpin": { "post": { "description": "__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).", "operationId": "post-revision-unpin", "summary": "Akamai Unpin an Active Revision", "tags": [ "Revisions" ], "externalDocs": { "description": "See documentation for this operation in Akamai's EdgeWorkers API", "url": "https://techdocs.akamai.com/edgeworkers/reference/post-revision-unpin" }, "requestBody": { "required": true, "content": { "application/json": { "example": { "unpinNote": "Unpin to re-enable dynamic activation" }, "schema": { "additionalProperties": false, "type": "object", "properties": { "unpinNote": { "description": "Note to specify why you're unpinning the revision.", "example": "{{unpinNote}}", "maxLength": 128, "minLength": 1, "type": "string" } }, "x-akamai": { "file-path": "schemas/revision-unpin-post.yaml" } } } } }, "responses": { "200": { "description": "Provides details for the unpinned EdgeWorker revision.", "content": { "application/json": { "example": { "accountId": "A-CCT5678", "activationId": 5, "checksum": "70f76db1a24a40fb194f69ef3d5d557abb11cd88f7fce035a1d21385daf50b6d", "createdTime": "2023-07-13T19:20:01Z", "edgeWorkerId": 42, "lastModifiedTime": "2023-08-14T17:20:09Z", "network": "STAGING", "pinNote": "Disable dynamic activation during moratorium", "pinnedBy": "jsmith", "pinnedTime": "2023-08-14T17:17:43Z", "revisionActivatedBy": "jsmith", "revisionActivatedTime": "2023-08-14T17:17:43Z", "revisionActivationStatus": "COMPLETE", "revisionId": "5-1", "unpinNote": "Unpin to re-enable dynamic activation", "unpinnedBy": "jsmith", "unpinnedTime": "2023-08-14T18:09:13Z", "version": "0.4" }, "schema": { "additionalProperties": false, "type": "object", "required": [ "edgeWorkerId", "version", "activationId", "revisionId", "accountId", "checksum", "revisionActivationStatus", "network", "createdTime", "lastModifiedTime", "pinnedBy", "pinnedTime", "unpinnedBy", "unpinnedTime" ], "properties": { "accountId": { "description": "Identifier for the account under which the EdgeWorker was created.", "minLength": 1, "type": "string" }, "activationId": { "description": "Unique identifier of the activation.", "minimum": 1, "type": "integer" }, "createdTime": { "description": "ISO 8601 timestamp indicating when the revision was created.", "format": "date-time", "type": "string" }, "edgeWorkerId": { "description": "Unique identifier of the EdgeWorker.", "minimum": 1, "type": "integer" }, "lastModifiedTime": { "description": "ISO 8601 timestamp indicating when the revision was most recently modified.", "format": "date-time", "type": "string" }, "network": { "description": "The network on which the revision is activated, either `PRODUCTION` or `STAGING`.", "type": "string", "enum": [ "STAGING", "PRODUCTION" ] }, "note": { "description": "Note to explain why you're reactivating the revision.", "maxLength": 128, "minLength": 1, "type": "string" }, "pinNote": { "description": "Note to explain why you're pinning the revision.", "maxLength": 128, "minLength": 1, "type": "string" }, "pinnedBy": { "description": "Username of the person who pinned the revision.", "minLength": 1, "type": "string" }, "pinnedTime": { "description": "ISO 8601 timestamp indicating when the revision was pinned.", "format": "date-time", "type": "string" }, "revisionActivatedBy": { "description": "Username of the person who reactivated the revision.", "minLength": 1, "type": "string" }, "revisionActivatedTime": { "description": "ISO 8601 timestamp indicating when the revision was most recently reactivated.", "format": "date-time", "type": "string" }, "revisionActivationStatus": { "description": "The activation status of the EdgeWorker revision, either `PRESUBMIT`, `PENDING`, `IN_PROGRESS`, `COMPLETE`, `CANCELLED`, `ABORTED`, `ERROR`, `DELETED_BY_AKAMAI`, `EXPIRED`, or `INVALID_COMBINED_BUNDLE`.", "type": "string", "enum": [ "PRESUBMIT", "PENDING", "IN_PROGRESS", "ABORTED", "ERROR", "COMPLETE", "DELETED_BY_AKAMAI", "EXPIRED", "CANCELLED", "INVALID_COMBINED_BUNDLE" ] }, "revisionId": { "description": "Unique identifier of the revision.", "minLength": 1, "type": "string" }, "unpinNote": { "description": "Note to explain why you're unpinning the revision.", "maxLength": 128, "minLength": 1, "type": "string" }, "unpinnedBy": { "description": "Username of the person who unpinned the revision.", "minLength": 1, "type": "string" }, "unpinnedTime": { "description": "ISO 8601 timestamp indicating when the revision was unpinned.", "format": "date-time", "type": "string" }, "version": { "description": "Unique identifier of the version.", "minLength": 1, "type": "string" } }, "x-akamai": { "file-path": "schemas/revision-unpin-post-200.yaml" } } } } } }, "x-akamai": { "status": "BETA" }, "parameters": [ { "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).", "example": "{{accountSwitchKey}}", "in": "query", "name": "accountSwitchKey", "required": false, "schema": { "example": "1-5C0YLB:1-8BYUX", "type": "string" } } ] }, "parameters": [ { "description": "Unique identifier for an EdgeWorker.", "example": "{{edgeWorkerId}}", "in": "path", "name": "edgeWorkerId", "required": true, "schema": { "example": 42, "minimum": 1, "type": "integer" }, "x-akamai": { "file-path": "parameters/edgeWorkerId-path.yaml" } }, { "description": "Unique identifier for an EdgeWorkers revision.", "example": "{{revisionId}}", "in": "path", "name": "revisionId", "required": true, "schema": { "example": "3-1", "type": "string" }, "x-akamai": { "file-path": "parameters/revisionId-path.yaml" } } ] }, "/ids/{edgeWorkerId}/versions": { "post": { "description": "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`.", "operationId": "post-versions", "summary": "Akamai Create a New Version", "tags": [ "Versions" ], "externalDocs": { "description": "See documentation for this operation in Akamai's EdgeWorkers API", "url": "https://techdocs.akamai.com/edgeworkers/reference/post-versions" }, "requestBody": { "required": true, "content": { "application/gzip": { "schema": { "format": "binary", "type": "string" } } } }, "responses": { "201": { "description": "Provides details for an EdgeWorker version.", "content": { "application/json": { "example": { "accountId": "A-CCT5678", "checksum": "de9f2c7fd25e1b3afad3e85a0bd17d9b100db4b3", "createdBy": "jsmith", "createdTime": "2020-07-05T18:17:46Z", "edgeWorkerId": 42, "version": "5" }, "schema": { "additionalProperties": false, "type": "object", "required": [ "edgeWorkerId", "version", "accountId", "checksum", "createdBy", "createdTime" ], "properties": { "accountId": { "description": "Identifier for the account where the EdgeWorker was created.", "minLength": 1, "type": "string" }, "checksum": { "description": "A SHA-256 hash digest of the tarball.", "minLength": 1, "type": "string" }, "createdBy": { "description": "Username of the person who created the EdgeWorker version.", "minLength": 1, "type": "string" }, "createdTime": { "description": "ISO 8601 timestamp indicating when the EdgeWorker version was created.", "format": "date-time", "type": "string" }, "edgeWorkerId": { "description": "Unique identifier of the EdgeWorker.", "minimum": 1, "type": "integer" }, "sequenceNumber": { "description": "An incrementing number indicating the upload order of the EdgeWorker versions.", "minLength": 1, "type": "string" }, "version": { "description": "Unique identifier of the EdgeWorker version.", "minLength": 1, "type": "string" } }, "x-akamai": { "file-path": "schemas/versions-post-201.yaml" } } } }, "headers": { "Location": { "description": "Use this URL to fetch the new resource.", "schema": { "type": "string" }, "x-akamai": { "file-path": "headers/Location.yaml" } } } } }, "parameters": [ { "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).", "example": "{{accountSwitchKey}}", "in": "query", "name": "accountSwitchKey", "required": false, "schema": { "example": "1-5C0YLB:1-8BYUX", "type": "string" } } ] }, "get": { "description": "View a list of EdgeWorker versions.", "operationId": "get-versions", "summary": "Akamai List Versions", "tags": [ "Versions" ], "externalDocs": { "description": "See documentation for this operation in Akamai's EdgeWorkers API", "url": "https://techdocs.akamai.com/edgeworkers/reference/get-versions" }, "responses": { "200": { "description": "This section describes a list of EdgeWorker versions.", "content": { "application/json": { "example": { "versions": [ { "accountId": "A-CCT5678", "checksum": "de9f2c7fd25e1b3afad3e85a0bd17d9b100db4b3", "createdBy": "jsmith", "createdTime": "2020-07-05T18:17:46Z", "edgeWorkerId": 42, "version": "1" }, { "accountId": "A-CCT9012", "checksum": "8277e0910d750195b448797616e091ad616e091a", "createdBy": "jsmith", "createdTime": "2020-07-05T23:01:34Z", "edgeWorkerId": 42, "version": "2" } ] }, "schema": { "additionalProperties": false, "type": "object", "required": [ "versions" ], "properties": { "versions": { "description": "List of EdgeWorker versions.", "minItems": 1, "type": "array", "items": { "additionalProperties": false, "type": "object", "required": [ "edgeWorkerId", "version", "accountId", "checksum", "createdBy", "createdTime" ], "properties": { "accountId": { "description": "Identifier for the account where the EdgeWorker was created.", "minLength": 1, "type": "string" }, "checksum": { "description": "A SHA-256 hash digest of the tarball.", "minLength": 1, "type": "string" }, "createdBy": { "description": "Username of the person who created the EdgeWorker version.", "minLength": 1, "type": "string" }, "createdTime": { "description": "ISO 8601 timestamp indicating when the EdgeWorker version was created.", "format": "date-time", "type": "string" }, "edgeWorkerId": { "description": "Unique identifier of the EdgeWorker.", "minimum": 1, "type": "integer" }, "sequenceNumber": { "description": "An incrementing number indicating the upload order of the EdgeWorker versions.", "minLength": 1, "type": "string" }, "version": { "description": "Unique identifier of the EdgeWorker version.", "minLength": 1, "type": "string" } }, "x-akamai": { "file-path": "schemas/version-get-200.yaml" } } } }, "x-akamai": { "file-path": "schemas/versions-get-200.yaml" } } } } } }, "parameters": [ { "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).", "example": "{{accountSwitchKey}}", "in": "query", "name": "accountSwitchKey", "required": false, "schema": { "example": "1-5C0YLB:1-8BYUX", "type": "string" } } ] }, "parameters": [ { "description": "Unique identifier for an EdgeWorker.", "example": "{{edgeWorkerId}}", "in": "path", "name": "edgeWorkerId", "required": true, "schema": { "example": 42, "minimum": 1, "type": "integer" }, "x-akamai": { "file-path": "parameters/edgeWorkerId-path.yaml" } } ] }, "/ids/{edgeWorkerId}/versions/{version}": { "get": { "description": "View details for a specific version.", "operationId": "get-version", "summary": "Akamai Get Version Details", "tags": [ "Versions" ], "externalDocs": { "description": "See documentation for this operation in Akamai's EdgeWorkers API", "url": "https://techdocs.akamai.com/edgeworkers/reference/get-version" }, "responses": { "200": { "description": "Provides details for an EdgeWorker version.", "content": { "application/json": { "example": { "accountId": "A-CCT9012", "checksum": "de9f2c7fd25e1b3afad3e85a0bd17d9b100db4b3", "createdBy": "jsmith", "createdTime": "2020-07-09T21:51:07Z", "edgeWorkerId": 42, "version": "3" }, "schema": { "additionalProperties": false, "type": "object", "required": [ "edgeWorkerId", "version", "accountId", "checksum", "createdBy", "createdTime" ], "properties": { "accountId": { "description": "Identifier for the account where the EdgeWorker was created.", "minLength": 1, "type": "string" }, "checksum": { "description": "A SHA-256 hash digest of the tarball.", "minLength": 1, "type": "string" }, "createdBy": { "description": "Username of the person who created the EdgeWorker version.", "minLength": 1, "type": "string" }, "createdTime": { "description": "ISO 8601 timestamp indicating when the EdgeWorker version was created.", "format": "date-time", "type": "string" }, "edgeWorkerId": { "description": "Unique identifier of the EdgeWorker.", "minimum": 1, "type": "integer" }, "sequenceNumber": { "description": "An incrementing number indicating the upload order of the EdgeWorker versions.", "minLength": 1, "type": "string" }, "version": { "description": "Unique identifier of the EdgeWorker version.", "minLength": 1, "type": "string" } }, "x-akamai": { "file-path": "schemas/version-get-200.yaml" } } } } } }, "parameters": [ { "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).", "example": "{{accountSwitchKey}}", "in": "query", "name": "accountSwitchKey", "required": false, "schema": { "example": "1-5C0YLB:1-8BYUX", "type": "string" } } ] }, "delete": { "description": "Delete a specific version.", "operationId": "delete-version", "summary": "Akamai Delete Version", "tags": [ "Versions" ], "externalDocs": { "description": "See documentation for this operation in Akamai's EdgeWorkers API", "url": "https://techdocs.akamai.com/edgeworkers/reference/delete-version" }, "responses": { "204": { "description": "Confirms the deletion of the EdgeWorker version.", "content": { "*/*": {} } } }, "parameters": [ { "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).", "example": "{{accountSwitchKey}}", "in": "query", "name": "accountSwitchKey", "required": false, "schema": { "example": "1-5C0YLB:1-8BYUX", "type": "string" } } ] }, "parameters": [ { "description": "Unique identifier for an EdgeWorker version.", "example": "{{version}}", "in": "path", "name": "version", "required": true, "schema": { "example": 5, "type": "integer" }, "x-akamai": { "file-path": "parameters/version-path.yaml" } }, { "description": "Unique identifier for an EdgeWorker.", "example": "{{edgeWorkerId}}", "in": "path", "name": "edgeWorkerId", "required": true, "schema": { "example": 42, "minimum": 1, "type": "integer" }, "x-akamai": { "file-path": "parameters/edgeWorkerId-path.yaml" } } ] }, "/ids/{edgeWorkerId}/versions/{version}/content": { "get": { "description": "Download the bundle containing the code the EdgeWorker executes.", "operationId": "get-version-content", "summary": "Akamai Download an EdgeWorkers Code Bundle", "tags": [ "Versions" ], "externalDocs": { "description": "See documentation for this operation in Akamai's EdgeWorkers API", "url": "https://techdocs.akamai.com/edgeworkers/reference/get-version-content" }, "responses": { "200": { "description": "Downloaded EdgeWorkers code bundle.", "content": { "application/gzip": { "schema": { "format": "binary", "type": "string" } } } } }, "parameters": [ { "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).", "example": "{{accountSwitchKey}}", "in": "query", "name": "accountSwitchKey", "required": false, "schema": { "example": "1-5C0YLB:1-8BYUX", "type": "string" } } ] }, "parameters": [ { "description": "Unique identifier for an EdgeWorker version.", "example": "{{version}}", "in": "path", "name": "version", "required": true, "schema": { "example": 5, "type": "integer" }, "x-akamai": { "file-path": "parameters/version-path.yaml" } }, { "description": "Unique identifier for an EdgeWorker.", "example": "{{edgeWorkerId}}", "in": "path", "name": "edgeWorkerId", "required": true, "schema": { "example": 42, "minimum": 1, "type": "integer" }, "x-akamai": { "file-path": "parameters/edgeWorkerId-path.yaml" } } ] }, "/limits": { "get": { "description": "View the various limits EdgeWorkers imposes on the number of activations, EdgeWorkers IDs, and versions you can deploy.", "operationId": "get-limits", "summary": "Akamai List Limits", "tags": [ "Limits" ], "externalDocs": { "description": "See documentation for this operation in Akamai's EdgeWorkers API", "url": "https://techdocs.akamai.com/edgeworkers/reference/get-limits" }, "responses": { "200": { "description": "Describes a list of Limits.", "content": { "application/json": { "example": { "limits": [ { "limitId": "ew-id-per-account-limit", "limitName": "Maximum number of EdgeWorker IDs per account", "limitValue": 200 }, { "limitId": "version-per-ew-id-limit", "limitName": "Maximum number of versions per EdgeWorker ID", "limitValue": 1000 }, { "limitId": "activation-per-network-per-minute-limit", "limitName": "Maximum number of activations each minute on a network per account", "limitValue": 20 }, { "limitId": "activation-per-day-limit", "limitName": "Maximum number of activations each day per account", "limitValue": 500 } ] }, "schema": { "additionalProperties": false, "description": "A list of limits that apply to your account.", "type": "object", "required": [ "limits" ], "properties": { "limits": { "description": "List of limits.", "minItems": 1, "type": "array", "items": { "additionalProperties": false, "description": "An object that includes the ID, name, and value of a limit.", "type": "object", "required": [ "limitId", "limitName", "limitValue" ], "properties": { "limitId": { "description": "Unique identifier of the limit.", "minLength": 1, "type": "string" }, "limitName": { "description": "Name of the limit.", "minLength": 1, "type": "string" }, "limitValue": { "description": "Value of the limit.", "minimum": 0, "type": "integer" } }, "x-akamai": { "file-path": "schemas/limit-get-200.yaml" } } } }, "x-akamai": { "file-path": "schemas/limits-get-200.yaml" } } } } } }, "parameters": [ { "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).", "example": "{{accountSwitchKey}}", "in": "query", "name": "accountSwitchKey", "required": false, "schema": { "example": "1-5C0YLB:1-8BYUX", "type": "string" } } ] } }, "/reports": { "get": { "description": "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).", "operationId": "get-reports", "summary": "Akamai List Reports", "tags": [ "Reports" ], "externalDocs": { "description": "See documentation for this operation in Akamai's EdgeWorkers API", "url": "https://techdocs.akamai.com/edgeworkers/reference/get-reports" }, "responses": { "200": { "description": "Describes a list of EdgeWorker reports.", "content": { "application/json": { "example": { "reports": [ { "description": "This report contains an overview of other reports.", "name": "Overall summary", "reportId": 1 }, { "description": "This report lists execution and initialization times, grouped by EdgeWorker ID and event handler.", "name": "Initialization and execution times by EdgeWorker ID and event handler", "reportId": 2, "unavailable": true }, { "description": "This report lists execution statuses, grouped by EdgeWorker ID and event handler.", "name": "Execution statuses by EdgeWorker ID and event handler", "reportId": 3 }, { "description": "This report lists memory usage, grouped by EdgeWorker ID and event handler.", "name": "Memory usage by EdgeWorker ID and event handler", "reportId": 4, "unavailable": true }, { "description": "This report lists execution and initialization times with percentiles, grouped by EdgeWorker ID and event handler.", "name": "Initialization and execution times with percentiles by EdgeWorker ID and event handler", "reportId": 5 }, { "description": "This report lists memory usage with percentiles, grouped by EdgeWorker ID and event handler.", "name": "Memory usage with percentiles by EdgeWorker ID and event handler", "reportId": 6 }, { "description": "This report contains the total number of sub-requests.", "name": "Sub-requests", "reportId": 7 } ] }, "schema": { "additionalProperties": false, "type": "object", "required": [ "reports" ], "properties": { "reports": { "description": "List of EdgeWorker reports.", "minItems": 1, "type": "array", "items": { "additionalProperties": false, "type": "object", "properties": { "data": { "description": "Object containing data points of the EdgeWorker report.", "oneOf": [ { "title": "Single report", "oneOf": [ { "additionalProperties": false, "description": "Specifies summary data for each EdgeWorker's usage.", "title": "Report 1", "type": "object", "required": [ "invocations", "successes", "errors", "execDuration", "initDuration", "memory" ], "properties": { "errors": { "additionalProperties": false, "description": "Failed event handler executions.", "type": "object", "required": [ "total" ], "properties": { "total": { "description": "Total number of failed executions.", "type": "integer" } } }, "execDuration": { "additionalProperties": false, "description": "Execution duration.", "type": "object", "required": [ "avg", "min", "max", "twentyFivePercentile", "fiftyPercentile", "seventyFivePercentile", "ninetyFivePercentile", "ninetyNinePercentile" ], "properties": { "avg": { "description": "Average clock time used to execute event handlers, in milliseconds.", "type": "number" }, "fiftyPercentile": { "description": "50% of the invocations took less execution time than this field's value, in milliseconds.", "type": "number" }, "max": { "description": "Maximum clock time used to execute event handlers, in milliseconds.", "type": "number" }, "min": { "description": "Minimum clock time used to execute event handlers, in milliseconds.", "type": "number" }, "ninetyFivePercentile": { "description": "95% of the invocations took less execution time than this field's value, in milliseconds.", "type": "number" }, "ninetyNinePercentile": { "description": "99% of the invocations took less execution time than this field's value, in milliseconds.", "type": "number" }, "seventyFivePercentile": { "description": "75% of the invocations took less execution time than this field's value, in milliseconds.", "type": "number" }, "twentyFivePercentile": { "description": "25% of the invocations took less execution time than this field's value, in milliseconds.", "type": "number" } }, "x-akamai": { "file-path": "schemas/report-exec-duration.yaml" } }, "initDuration": { "additionalProperties": false, "description": "Initialization duration.", "type": "object", "required": [ "avg", "min", "max", "twentyFivePercentile", "fiftyPercentile", "seventyFivePercentile", "ninetyFivePercentile", "ninetyNinePercentile" ], "properties": { "avg": { "description": "Average clock time used to initialize the event handlers, in milliseconds. The average is the sum of durations divided by the number of executions.", "type": "number" }, "fiftyPercentile": { "description": "50% of the invocations took less initialization time than this field's value, in milliseconds.", "type": "number" }, "max": { "description": "Maximum clock time used to initialize the event handlers, in milliseconds.", "type": "number" }, "min": { "description": "Minimum clock time used to initialize the event handlers, in milliseconds.", "type": "number" }, "ninetyFivePercentile": { "description": "95% of the invocations took less initialization time than this field's value, in milliseconds.", "type": "number" }, "ninetyNinePercentile": { "description": "99% of the invocations took less initialization time than this field's value, in milliseconds.", "type": "number" }, "seventyFivePercentile": { "description": "75% of the invocations took less initialization time than this field's value, in milliseconds.", "type": "number" }, "twentyFivePercentile": { "description": "25% of the invocations took less initialization time than this field's value, in milliseconds.", "type": "number" } }, "x-akamai": { "file-path": "schemas/report-init-duration.yaml" } }, "invocations": { "additionalProperties": false, "description": "Number of executions.", "type": "object", "required": [ "total" ], "properties": { "total": { "description": "Total number of executions.", "type": "integer" } } }, "memory": { "additionalProperties": false, "description": "Memory usage.", "type": "object", "required": [ "avg", "min", "max", "twentyFivePercentile", "fiftyPercentile", "seventyFivePercentile", "ninetyFivePercentile", "ninetyNinePercentile" ], "properties": { "avg": { "description": "Average memory used to execute event handlers.", "type": "number" }, "fiftyPercentile": { "description": "50% of the invocations took less memory than this field's value.", "type": "number" }, "max": { "description": "Maximum memory used to execute event handlers.", "type": "number" }, "min": { "description": "Minimum memory used to execute event handlers.", "type": "number" }, "ninetyFivePercentile": { "description": "95% of the invocations took less memory than this field's value.", "type": "number" }, "ninetyNinePercentile": { "description": "99% of the invocations took less memory than this field's value.", "type": "number" }, "seventyFivePercentile": { "description": "75% of the invocations took less memory than this field's value.", "type": "number" }, "twentyFivePercentile": { "description": "25% of the invocations took less memory than this field's value.", "type": "number" } }, "x-akamai": { "file-path": "schemas/report-memory-usage.yaml" } }, "successes": { "additionalProperties": false, "description": "Successful event handler executions.", "type": "object", "required": [ "total" ], "properties": { "total": { "description": "Total number of successful executions.", "type": "integer" } } } }, "x-akamai": { "file-path": "schemas/report-1.yaml" } }, { "additionalProperties": false, "description": "Specifies execution and initialization times, grouped by event handler for each EdgeWorker.", "title": "Report 2", "type": "object", "required": [ "edgeWorkerId", "data" ], "properties": { "data": { "description": "Data points grouped by event handler and initialization mapping keys.", "type": "object", "additionalProperties": { "description": "Up to four event handler arrays and an init array for initialization data points.", "type": "array", "items": { "additionalProperties": false, "description": "Aggregated execution or initialization durations.", "type": "object", "required": [ "startDateTime", "edgeWorkerVersion", "invocations" ], "properties": { "edgeWorkerVersion": { "description": "The EdgeWorker version that was active during the execution of event handlers.", "type": "string" }, "execDuration": { "additionalProperties": false, "description": "Execution duration.", "type": "object", "required": [ "avg", "min", "max", "twentyFivePercentile", "fiftyPercentile", "seventyFivePercentile", "ninetyFivePercentile", "ninetyNinePercentile" ], "properties": { "avg": { "description": "Average clock time used to execute event handlers, in milliseconds.", "type": "number" }, "fiftyPercentile": { "description": "50% of the invocations took less execution time than this field's value, in milliseconds.", "type": "number" }, "max": { "description": "Maximum clock time used to execute event handlers, in milliseconds.", "type": "number" }, "min": { "description": "Minimum clock time used to execute event handlers, in milliseconds.", "type": "number" }, "ninetyFivePercentile": { "description": "95% of the invocations took less execution time than this field's value, in milliseconds.", "type": "number" }, "ninetyNinePercentile": { "description": "99% of the invocations took less execution time than this field's value, in milliseconds.", "type": "number" }, "seventyFivePercentile": { "description": "75% of the invocations took less execution time than this field's value, in milliseconds.", "type": "number" }, "twentyFivePercentile": { "description": "25% of the invocations took less execution time than this field's value, in milliseconds.", "type": "number" } }, "x-akamai": { "file-path": "schemas/report-exec-duration.yaml" } }, "initDuration": { "additionalProperties": false, "description": "Initialization duration.", "type": "object", "required": [ "avg", "min", "max", "twentyFivePercentile", "fiftyPercentile", "seventyFivePercentile", "ninetyFivePercentile", "ninetyNinePercentile" ], "properties": { "avg": { "description": "Average clock time used to initialize the event handlers, in milliseconds. The average is the sum of durations divided by the number of executions.", "type": "number" }, "fiftyPercentile": { "description": "50% of the invocations took less initialization time than this field's value, in milliseconds.", "type": "number" }, "max": { "description": "Maximum clock time used to initialize the event handlers, in milliseconds.", "type": "number" }, "min": { "description": "Minimum clock time used to initialize the event handlers, in milliseconds.", "type": "number" }, "ninetyFivePercentile": { "description": "95% of the invocations took less initialization time than this field's value, in milliseconds.", "type": "number" }, "ninetyNinePercentile": { "description": "99% of the invocations took less initialization time than this field's value, in milliseconds.", "type": "number" }, "seventyFivePercentile": { "description": "75% of the invocations took less initialization time than this field's value, in milliseconds.", "type": "number" }, "twentyFivePercentile": { "description": "25% of the invocations took less initialization time than this field's value, in milliseconds.", "type": "number" } }, "x-akamai": { "file-path": "schemas/report-init-duration.yaml" } }, "invocations": { "description": "Number of aggregated executions or initializations.", "type": "integer" }, "startDateTime": { "description": "Start date of the time period (ISO 8601).", "type": "string" } } } } }, "edgeWorkerId": { "description": "Unique identifier for an EdgeWorker.", "type": "integer" } }, "x-akamai": { "file-path": "schemas/report-2.yaml" } }, { "additionalProperties": false, "description": "Specifies execution success and error statuses, grouped by event handler for each EdgeWorker.", "title": "Report 3", "type": "object", "required": [ "edgeWorkerId", "data" ], "properties": { "data": { "description": "Data points grouped by event handler mapping keys.", "type": "object", "additionalProperties": { "description": "Up to four event handler arrays.", "type": "array", "items": { "additionalProperties": false, "description": "Aggregated execution status.", "type": "object", "required": [ "startDateTime", "edgeWorkerVersion", "status", "invocations" ], "properties": { "edgeWorkerVersion": { "description": "The EdgeWorker version that was active during the execution of event handlers.", "type": "string" }, "invocations": { "description": "Number of aggregated executions.", "type": "integer" }, "startDateTime": { "description": "Start date of the time period (ISO 8601).", "type": "string" }, "status": { "description": "Execution status.", "type": "string" } } } } }, "edgeWorkerId": { "description": "Unique identifier for an EdgeWorker.", "type": "integer" } }, "x-akamai": { "file-path": "schemas/report-3.yaml" } }, { "additionalProperties": false, "description": "Data array of EdgeWorker report ID 4.", "title": "Report 4", "type": "object", "required": [ "edgeWorkerId", "data" ], "properties": { "data": { "description": "Data points grouped by event handler mapping keys.", "type": "object", "additionalProperties": { "description": "Up to four event handler arrays.", "type": "array", "items": { "additionalProperties": false, "description": "Aggregated memory usage.", "type": "object", "required": [ "startDateTime", "edgeWorkerVersion", "memory", "invocations" ], "properties": { "edgeWorkerVersion": { "description": "The EdgeWorker version that was active during the execution of event handlers.", "type": "string" }, "invocations": { "description": "Number of aggregated executions.", "type": "integer" }, "memory": { "additionalProperties": false, "description": "Memory usage.", "type": "object", "required": [ "avg", "min", "max", "twentyFivePercentile", "fiftyPercentile", "seventyFivePercentile", "ninetyFivePercentile", "ninetyNinePercentile" ], "properties": { "avg": { "description": "Average memory used to execute event handlers.", "type": "number" }, "fiftyPercentile": { "description": "50% of the invocations took less memory than this field's value.", "type": "number" }, "max": { "description": "Maximum memory used to execute event handlers.", "type": "number" }, "min": { "description": "Minimum memory used to execute event handlers.", "type": "number" }, "ninetyFivePercentile": { "description": "95% of the invocations took less memory than this field's value.", "type": "number" }, "ninetyNinePercentile": { "description": "99% of the invocations took less memory than this field's value.", "type": "number" }, "seventyFivePercentile": { "description": "75% of the invocations took less memory than this field's value.", "type": "number" }, "twentyFivePercentile": { "description": "25% of the invocations took less memory than this field's value.", "type": "number" } }, "x-akamai": { "file-path": "schemas/report-memory-usage.yaml" } }, "startDateTime": { "description": "Start date of the time period (ISO 8601).", "type": "string" } } } } }, "edgeWorkerId": { "description": "Unique identifier for an EdgeWorker.", "type": "integer" } }, "x-akamai": { "file-path": "schemas/report-4.yaml" } }, { "additionalProperties": false, "description": "Specifies execution and initialization times with percentiles, grouped by event handler for each EdgeWorker ID.", "title": "Report 5", "type": "object", "required": [ "edgeWorkerId", "data", "summaryStatistics" ], "properties": { "data": { "description": "Data points grouped by event handler and initialization mapping keys.", "type": "object", "additionalProperties": { "description": "Up to four event handler arrays and an init array for initialization data points.", "type": "array", "items": { "additionalProperties": false, "description": "Aggregated execution or initialization durations.", "type": "object", "required": [ "startDateTime", "edgeWorkerVersion", "invocations" ], "properties": { "edgeWorkerVersion": { "description": "The EdgeWorker version active when the event handler executed.", "type": "string" }, "execDuration": { "additionalProperties": false, "description": "Execution duration.", "type": "object", "required": [ "avg", "min", "max", "twentyFivePercentile", "fiftyPercentile", "seventyFivePercentile", "ninetyFivePercentile", "ninetyNinePercentile" ], "properties": { "avg": { "description": "Average clock time used to execute event handlers, in milliseconds.", "type": "number" }, "fiftyPercentile": { "description": "50% of the invocations took less execution time than this field's value, in milliseconds.", "type": "number" }, "max": { "description": "Maximum clock time used to execute event handlers, in milliseconds.", "type": "number" }, "min": { "description": "Minimum clock time used to execute event handlers, in milliseconds.", "type": "number" }, "ninetyFivePercentile": { "description": "95% of the invocations took less execution time than this field's value, in milliseconds.", "type": "number" }, "ninetyNinePercentile": { "description": "99% of the invocations took less execution time than this field's value, in milliseconds.", "type": "number" }, "seventyFivePercentile": { "description": "75% of the invocations took less execution time than this field's value, in milliseconds.", "type": "number" }, "twentyFivePercentile": { "description": "25% of the invocations took less execution time than this field's value, in milliseconds.", "type": "number" } }, "x-akamai": { "file-path": "schemas/report-exec-duration.yaml" } }, "initDuration": { "additionalProperties": false, "description": "Initialization duration.", "type": "object", "required": [ "avg", "min", "max", "twentyFivePercentile", "fiftyPercentile", "seventyFivePercentile", "ninetyFivePercentile", "ninetyNinePercentile" ], "properties": { "avg": { "description": "Average clock time used to initialize the event handlers, in milliseconds. The average is the sum of durations divided by the number of executions.", "type": "number" }, "fiftyPercentile": { "description": "50% of the invocations took less initialization time than this field's value, in milliseconds.", "type": "number" }, "max": { "description": "Maximum clock time used to initialize the event handlers, in milliseconds.", "type": "number" }, "min": { "description": "Minimum clock time used to initialize the event handlers, in milliseconds.", "type": "number" }, "ninetyFivePercentile": { "description": "95% of the invocations took less initialization time than this field's value, in milliseconds.", "type": "number" }, "ninetyNinePercentile": { "description": "99% of the invocations took less initialization time than this field's value, in milliseconds.", "type": "number" }, "seventyFivePercentile": { "description": "75% of the invocations took less initialization time than this field's value, in milliseconds.", "type": "number" }, "twentyFivePercentile": { "description": "25% of the invocations took less initialization time than this field's value, in milliseconds.", "type": "number" } }, "x-akamai": { "file-path": "schemas/report-init-duration.yaml" } }, "invocations": { "description": "Number of aggregated executions or initializations.", "type": "integer" }, "startDateTime": { "description": "Start date of the time period (ISO 8601).", "type": "string" } } } } }, "edgeWorkerId": { "description": "Unique identifier for an EdgeWorker.", "type": "integer" }, "summaryStatistics": { "additionalProperties": false, "description": "Execution and initialization time summary in percentiles.", "type": "object", "required": [ "init", "onClientRequest", "onClientResponse", "onOriginRequest", "onOriginResponse", "responseProvider", "totalExecTime" ], "properties": { "init": { "additionalProperties": false, "description": "Initialization time summary in percentiles.", "type": "object", "required": [ "twentyFivePercentile", "fiftyPercentile", "seventyFivePercentile", "ninetyFivePercentile", "ninetyNinePercentile" ], "properties": { "fiftyPercentile": { "description": "50% of the invocations took less time than this field's value, in milliseconds.", "type": "number" }, "ninetyFivePercentile": { "description": "95% of the invocations took less time than this field's value, in milliseconds.", "type": "number" }, "ninetyNinePercentile": { "description": "99% of the invocations took less time than this field's value, in milliseconds.", "type": "number" }, "seventyFivePercentile": { "description": "75% of the invocations took less time than this field's value, in milliseconds.", "type": "number" }, "twentyFivePercentile": { "description": "25% of the invocations took less time than this field's value, in milliseconds.", "type": "number" } }, "x-akamai": { "file-path": "schemas/report-exec-and-init-summary.yaml" } }, "onClientRequest": { "additionalProperties": false, "description": "Execution time summary in percentiles for all invocations of `onClientRequest`.", "type": "object", "required": [ "twentyFivePercentile", "fiftyPercentile", "seventyFivePercentile", "ninetyFivePercentile", "ninetyNinePercentile" ], "properties": { "fiftyPercentile": { "description": "50% of the invocations took less time than this field's value, in milliseconds.", "type": "number" }, "ninetyFivePercentile": { "description": "95% of the invocations took less time than this field's value, in milliseconds.", "type": "number" }, "ninetyNinePercentile": { "description": "99% of the invocations took less time than this field's value, in milliseconds.", "type": "number" }, "seventyFivePercentile": { "description": "75% of the invocations took less time than this field's value, in milliseconds.", "type": "number" }, "twentyFivePercentile": { "description": "25% of the invocations took less time than this field's value, in milliseconds.", "type": "number" } }, "x-akamai": { "file-path": "schemas/report-exec-and-init-summary.yaml" } }, "onClientResponse": { "additionalProperties": false, "description": "Execution time summary in percentiles for all invocations of `onClientResponse`.", "type": "object", "required": [ "twentyFivePercentile", "fiftyPercentile", "seventyFivePercentile", "ninetyFivePercentile", "ninetyNinePercentile" ], "properties": { "fiftyPercentile": { "description": "50% of the invocations took less time than this field's value, in milliseconds.", "type": "number" }, "ninetyFivePercentile": { "description": "95% of the invocations took less time than this field's value, in milliseconds.", "type": "number" }, "ninetyNinePercentile": { "description": "99% of the invocations took less time than this field's value, in milliseconds.", "type": "number" }, "seventyFivePercentile": { "description": "75% of the invocations took less time than this field's value, in milliseconds.", "type": "number" }, "twentyFivePercentile": { "description": "25% of the invocations took less time than this field's value, in milliseconds.", "type": "number" } }, "x-akamai": { "file-path": "schemas/report-exec-and-init-summary.yaml" } }, "onOriginRequest": { "additionalProperties": false, "description": "Execution time summary in percentiles for all invocations of `onOriginRequest`.", "type": "object", "required": [ "twentyFivePercentile", "fiftyPercentile", "seventyFivePercentile", "ninetyFivePercentile", "ninetyNinePercentile" ], "properties": { "fiftyPercentile": { "description": "50% of the invocations took less time than this field's value, in milliseconds.", "type": "number" }, "ninetyFivePercentile": { "description": "95% of the invocations took less time than this field's value, in milliseconds.", "type": "number" }, "ninetyNinePercentile": { "description": "99% of the invocations took less time than this field's value, in milliseconds.", "type": "number" }, "seventyFivePercentile": { "description": "75% of the invocations took less time than this field's value, in milliseconds.", "type": "number" }, "twentyFivePercentile": { "description": "25% of the invocations took less time than this field's value, in milliseconds.", "type": "number" } }, "x-akamai": { "file-path": "schemas/report-exec-and-init-summary.yaml" } }, "onOriginResponse": { "additionalProperties": false, "description": "Execution time summary in percentiles for all invocations of `onOriginResponse`.", "type": "object", "required": [ "twentyFivePercentile", "fiftyPercentile", "seventyFivePercentile", "ninetyFivePercentile", "ninetyNinePercentile" ], "properties": { "fiftyPercentile": { "description": "50% of the invocations took less time than this field's value, in milliseconds.", "type": "number" }, "ninetyFivePercentile": { "description": "95% of the invocations took less time than this field's value, in milliseconds.", "type": "number" }, "ninetyNinePercentile": { "description": "99% of the invocations took less time than this field's value, in milliseconds.", "type": "number" }, "seventyFivePercentile": { "description": "75% of the invocations took less time than this field's value, in milliseconds.", "type": "number" }, "twentyFivePercentile": { "description": "25% of the invocations took less time than this field's value, in milliseconds.", "type": "number" } }, "x-akamai": { "file-path": "schemas/report-exec-and-init-summary.yaml" } }, "responseProvider": { "additionalProperties": false, "description": "Execution time summary in percentiles for all invocations of `responseProvider`.", "type": "object", "required": [ "twentyFivePercentile", "fiftyPercentile", "seventyFivePercentile", "ninetyFivePercentile", "ninetyNinePercentile" ], "properties": { "fiftyPercentile": { "description": "50% of the invocations took less time than this field's value, in milliseconds.", "type": "number" }, "ninetyFivePercentile": { "description": "95% of the invocations took less time than this field's value, in milliseconds.", "type": "number" }, "ninetyNinePercentile": { "description": "99% of the invocations took less time than this field's value, in milliseconds.", "type": "number" }, "seventyFivePercentile": { "description": "75% of the invocations took less time than this field's value, in milliseconds.", "type": "number" }, "twentyFivePercentile": { "description": "25% of the invocations took less time than this field's value, in milliseconds.", "type": "number" } }, "x-akamai": { "file-path": "schemas/report-exec-and-init-summary.yaml" } }, "totalExecTime": { "additionalProperties": false, "description": "Execution time summary in percentiles for all five event handlers.", "type": "object", "required": [ "twentyFivePercentile", "fiftyPercentile", "seventyFivePercentile", "ninetyFivePercentile", "ninetyNinePercentile" ], "properties": { "fiftyPercentile": { "description": "50% of the invocations took less time than this field's value, in milliseconds.", "type": "number" }, "ninetyFivePercentile": { "description": "95% of the invocations took less time than this field's value, in milliseconds.", "type": "number" }, "ninetyNinePercentile": { "description": "99% of the invocations took less time than this field's value, in milliseconds.", "type": "number" }, "seventyFivePercentile": { "description": "75% of the invocations took less time than this field's value, in milliseconds.", "type": "number" }, "twentyFivePercentile": { "description": "25% of the invocations took less time than this field's value, in milliseconds.", "type": "number" } }, "x-akamai": { "file-path": "schemas/report-exec-and-init-summary.yaml" } } } } }, "x-akamai": { "file-path": "schemas/report-5.yaml" } }, { "additionalProperties": false, "description": "Specifies memory usages with percentiles, grouped by event handler for each EdgeWorker ID.", "title": "Report 6", "type": "object", "required": [ "edgeWorkerId", "data", "summaryStatistics" ], "properties": { "data": { "description": "Data points grouped by event handler mapping keys.", "type": "object", "additionalProperties": { "description": "Up to four event handler arrays.", "type": "array", "items": { "additionalProperties": false, "description": "Aggregated memory usage.", "type": "object", "required": [ "startDateTime", "edgeWorkerVersion", "memory", "invocations" ], "properties": { "edgeWorkerVersion": { "description": "The EdgeWorker version that was active during the execution of event handlers.", "type": "string" }, "invocations": { "description": "Number of aggregated executions.", "type": "integer" }, "memory": { "additionalProperties": false, "description": "Memory usage (bytes).", "type": "object", "required": [ "avg", "min", "max", "twentyFivePercentile", "fiftyPercentile", "seventyFivePercentile", "ninetyFivePercentile", "ninetyNinePercentile" ], "properties": { "avg": { "description": "Average memory used to execute event handlers.", "type": "number" }, "fiftyPercentile": { "description": "50% of the invocations took less memory than this field's value.", "type": "number" }, "max": { "description": "Maximum memory used to execute event handlers.", "type": "number" }, "min": { "description": "Minimum memory used to execute event handlers.", "type": "number" }, "ninetyFivePercentile": { "description": "95% of the invocations took less memory than this field's value.", "type": "number" }, "ninetyNinePercentile": { "description": "99% of the invocations took less memory than this field's value.", "type": "number" }, "seventyFivePercentile": { "description": "75% of the invocations took less memory than this field's value.", "type": "number" }, "twentyFivePercentile": { "description": "25% of the invocations took less memory than this field's value.", "type": "number" } }, "x-akamai": { "file-path": "schemas/report-memory-usage.yaml" } }, "startDateTime": { "description": "Start date of the time period (ISO 8601).", "type": "string" } } } } }, "edgeWorkerId": { "description": "Unique identifier for an EdgeWorker.", "type": "integer" }, "summaryStatistics": { "additionalProperties": false, "description": "Memory usage summary in percentiles by event handler.", "type": "object", "required": [ "onClientRequest", "onClientResponse", "onOriginRequest", "onOriginResponse", "responseProvider", "totalMemoryUsage" ], "properties": { "onClientRequest": { "additionalProperties": false, "description": "Memory usage summary in percentiles for all invocations of `onClientRequest`.", "type": "object", "required": [ "twentyFivePercentile", "fiftyPercentile", "seventyFivePercentile", "ninetyFivePercentile", "ninetyNinePercentile" ], "properties": { "fiftyPercentile": { "description": "50% of the invocations took less memory than this field's value.", "type": "number" }, "ninetyFivePercentile": { "description": "95% of the invocations took less memory than this field's value.", "type": "number" }, "ninetyNinePercentile": { "description": "99% of the invocations took less memory than this field's value.", "type": "number" }, "seventyFivePercentile": { "description": "75% of the invocations took less memory than this field's value.", "type": "number" }, "twentyFivePercentile": { "description": "25% of the invocations took less memory than this field's value.", "type": "number" } }, "x-akamai": { "file-path": "schemas/report-memory-usage-summary.yaml" } }, "onClientResponse": { "additionalProperties": false, "description": "Memory usage summary in percentiles for all invocations of `onClientResponse`.", "type": "object", "required": [ "twentyFivePercentile", "fiftyPercentile", "seventyFivePercentile", "ninetyFivePercentile", "ninetyNinePercentile" ], "properties": { "fiftyPercentile": { "description": "50% of the invocations took less memory than this field's value.", "type": "number" }, "ninetyFivePercentile": { "description": "95% of the invocations took less memory than this field's value.", "type": "number" }, "ninetyNinePercentile": { "description": "99% of the invocations took less memory than this field's value.", "type": "number" }, "seventyFivePercentile": { "description": "75% of the invocations took less memory than this field's value.", "type": "number" }, "twentyFivePercentile": { "description": "25% of the invocations took less memory than this field's value.", "type": "number" } }, "x-akamai": { "file-path": "schemas/report-memory-usage-summary.yaml" } }, "onOriginRequest": { "additionalProperties": false, "description": "Memory usage summary in percentiles for all invocations of `onOriginRequest`.", "type": "object", "required": [ "twentyFivePercentile", "fiftyPercentile", "seventyFivePercentile", "ninetyFivePercentile", "ninetyNinePercentile" ], "properties": { "fiftyPercentile": { "description": "50% of the invocations took less memory than this field's value.", "type": "number" }, "ninetyFivePercentile": { "description": "95% of the invocations took less memory than this field's value.", "type": "number" }, "ninetyNinePercentile": { "description": "99% of the invocations took less memory than this field's value.", "type": "number" }, "seventyFivePercentile": { "description": "75% of the invocations took less memory than this field's value.", "type": "number" }, "twentyFivePercentile": { "description": "25% of the invocations took less memory than this field's value.", "type": "number" } }, "x-akamai": { "file-path": "schemas/report-memory-usage-summary.yaml" } }, "onOriginResponse": { "additionalProperties": false, "description": "Memory usage summary in percentiles for all invocations of `onOriginResponse`.", "type": "object", "required": [ "twentyFivePercentile", "fiftyPercentile", "seventyFivePercentile", "ninetyFivePercentile", "ninetyNinePercentile" ], "properties": { "fiftyPercentile": { "description": "50% of the invocations took less memory than this field's value.", "type": "number" }, "ninetyFivePercentile": { "description": "95% of the invocations took less memory than this field's value.", "type": "number" }, "ninetyNinePercentile": { "description": "99% of the invocations took less memory than this field's value.", "type": "number" }, "seventyFivePercentile": { "description": "75% of the invocations took less memory than this field's value.", "type": "number" }, "twentyFivePercentile": { "description": "25% of the invocations took less memory than this field's value.", "type": "number" } }, "x-akamai": { "file-path": "schemas/report-memory-usage-summary.yaml" } }, "responseProvider": { "additionalProperties": false, "description": "Memory usage summary in percentiles for all invocations of `responseProvider`.", "type": "object", "required": [ "twentyFivePercentile", "fiftyPercentile", "seventyFivePercentile", "ninetyFivePercentile", "ninetyNinePercentile" ], "properties": { "fiftyPercentile": { "description": "50% of the invocations took less memory than this field's value.", "type": "number" }, "ninetyFivePercentile": { "description": "95% of the invocations took less memory than this field's value.", "type": "number" }, "ninetyNinePercentile": { "description": "99% of the invocations took less memory than this field's value.", "type": "number" }, "seventyFivePercentile": { "description": "75% of the invocations took less memory than this field's value.", "type": "number" }, "twentyFivePercentile": { "description": "25% of the invocations took less memory than this field's value.", "type": "number" } }, "x-akamai": { "file-path": "schemas/report-memory-usage-summary.yaml" } }, "totalMemoryUsage": { "additionalProperties": false, "description": "Memory usage summary in percentiles for all five event handlers.", "type": "object", "required": [ "twentyFivePercentile", "fiftyPercentile", "seventyFivePercentile", "ninetyFivePercentile", "ninetyNinePercentile" ], "properties": { "fiftyPercentile": { "description": "50% of the invocations took less memory than this field's value.", "type": "number" }, "ninetyFivePercentile": { "description": "95% of the invocations took less memory than this field's value.", "type": "number" }, "ninetyNinePercentile": { "description": "99% of the invocations took less memory than this field's value.", "type": "number" }, "seventyFivePercentile": { "description": "75% of the invocations took less memory than this field's value.", "type": "number" }, "twentyFivePercentile": { "description": "25% of the invocations took less memory than this field's value.", "type": "number" } }, "x-akamai": { "file-path": "schemas/report-memory-usage-summary.yaml" } } } } }, "x-akamai": { "file-path": "schemas/report-6.yaml" } }, { "description": "Specifies the total number of sub-requests.", "title": "Report 7", "type": "object", "items": { "additionalProperties": false, "description": "Subrequest data object.", "type": "object", "required": [ "subRequests" ], "properties": { "subRequests": { "description": "Total number of sub-requests.", "type": "object", "properties": { "total": { "description": "Total number of sub-requests.", "type": "integer" } } } } }, "x-akamai": { "file-path": "schemas/report-7.yaml" } } ] }, { "title": "List of reports", "type": "array", "items": { "oneOf": [ { "additionalProperties": false, "description": "Specifies execution and initialization times, grouped by event handler for each EdgeWorker.", "title": "Report 2", "type": "object", "required": [ "edgeWorkerId", "data" ], "properties": { "data": { "description": "Data points grouped by event handler and initialization mapping keys.", "type": "object", "additionalProperties": { "description": "Up to four event handler arrays and an init array for initialization data points.", "type": "array", "items": { "additionalProperties": false, "description": "Aggregated execution or initialization durations.", "type": "object", "required": [ "startDateTime", "edgeWorkerVersion", "invocations" ], "properties": { "edgeWorkerVersion": { "description": "The EdgeWorker version that was active during the execution of event handlers.", "type": "string" }, "execDuration": { "additionalProperties": false, "description": "Execution duration.", "type": "object", "required": [ "avg", "min", "max", "twentyFivePercentile", "fiftyPercentile", "seventyFivePercentile", "ninetyFivePercentile", "ninetyNinePercentile" ], "properties": { "avg": { "description": "Average clock time used to execute event handlers, in milliseconds.", "type": "number" }, "fiftyPercentile": { "description": "50% of the invocations took less execution time than this field's value, in milliseconds.", "type": "number" }, "max": { "description": "Maximum clock time used to execute event handlers, in milliseconds.", "type": "number" }, "min": { "description": "Minimum clock time used to execute event handlers, in milliseconds.", "type": "number" }, "ninetyFivePercentile": { "description": "95% of the invocations took less execution time than this field's value, in milliseconds.", "type": "number" }, "ninetyNinePercentile": { "description": "99% of the invocations took less execution time than this field's value, in milliseconds.", "type": "number" }, "seventyFivePercentile": { "description": "75% of the invocations took less execution time than this field's value, in milliseconds.", "type": "number" }, "twentyFivePercentile": { "description": "25% of the invocations took less execution time than this field's value, in milliseconds.", "type": "number" } }, "x-akamai": { "file-path": "schemas/report-exec-duration.yaml" } }, "initDuration": { "additionalProperties": false, "description": "Initialization duration.", "type": "object", "required": [ "avg", "min", "max", "twentyFivePercentile", "fiftyPercentile", "seventyFivePercentile", "ninetyFivePercentile", "ninetyNinePercentile" ], "properties": { "avg": { "description": "Average clock time used to initialize the event handlers, in milliseconds. The average is the sum of durations divided by the number of executions.", "type": "number" }, "fiftyPercentile": { "description": "50% of the invocations took less initialization time than this field's value, in milliseconds.", "type": "number" }, "max": { "description": "Maximum clock time used to initialize the event handlers, in milliseconds.", "type": "number" }, "min": { "description": "Minimum clock time used to initialize the event handlers, in milliseconds.", "type": "number" }, "ninetyFivePercentile": { "description": "95% of the invocations took less initialization time than this field's value, in milliseconds.", "type": "number" }, "ninetyNinePercentile": { "description": "99% of the invocations took less initialization time than this field's value, in milliseconds.", "type": "number" }, "seventyFivePercentile": { "description": "75% of the invocations took less initialization time than this field's value, in milliseconds.", "type": "number" }, "twentyFivePercentile": { "description": "25% of the invocations took less initialization time than this field's value, in milliseconds.", "type": "number" } }, "x-akamai": { "file-path": "schemas/report-init-duration.yaml" } }, "invocations": { "description": "Number of aggregated executions or initializations.", "type": "integer" }, "startDateTime": { "description": "Start date of the time period (ISO 8601).", "type": "string" } } } } }, "edgeWorkerId": { "description": "Unique identifier for an EdgeWorker.", "type": "integer" } }, "x-akamai": { "file-path": "schemas/report-2.yaml" } }, { "additionalProperties": false, "description": "Specifies execution success and error statuses, grouped by event handler for each EdgeWorker.", "title": "Report 3", "type": "object", "required": [ "edgeWorkerId", "data" ], "properties": { "data": { "description": "Data points grouped by event handler mapping keys.", "type": "object", "additionalProperties": { "description": "Up to four event handler arrays.", "type": "array", "items": { "additionalProperties": false, "description": "Aggregated execution status.", "type": "object", "required": [ "startDateTime", "edgeWorkerVersion", "status", "invocations" ], "properties": { "edgeWorkerVersion": { "description": "The EdgeWorker version that was active during the execution of event handlers.", "type": "string" }, "invocations": { "description": "Number of aggregated executions.", "type": "integer" }, "startDateTime": { "description": "Start date of the time period (ISO 8601).", "type": "string" }, "status": { "description": "Execution status.", "type": "string" } } } } }, "edgeWorkerId": { "description": "Unique identifier for an EdgeWorker.", "type": "integer" } }, "x-akamai": { "file-path": "schemas/report-3.yaml" } }, { "additionalProperties": false, "description": "Data array of EdgeWorker report ID 4.", "title": "Report 4", "type": "object", "required": [ "edgeWorkerId", "data" ], "properties": { "data": { "description": "Data points grouped by event handler mapping keys.", "type": "object", "additionalProperties": { "description": "Up to four event handler arrays.", "type": "array", "items": { "additionalProperties": false, "description": "Aggregated memory usage.", "type": "object", "required": [ "startDateTime", "edgeWorkerVersion", "memory", "invocations" ], "properties": { "edgeWorkerVersion": { "description": "The EdgeWorker version that was active during the execution of event handlers.", "type": "string" }, "invocations": { "description": "Number of aggregated executions.", "type": "integer" }, "memory": { "additionalProperties": false, "description": "Memory usage.", "type": "object", "required": [ "avg", "min", "max", "twentyFivePercentile", "fiftyPercentile", "seventyFivePercentile", "ninetyFivePercentile", "ninetyNinePercentile" ], "properties": { "avg": { "description": "Average memory used to execute event handlers.", "type": "number" }, "fiftyPercentile": { "description": "50% of the invocations took less memory than this field's value.", "type": "number" }, "max": { "description": "Maximum memory used to execute event handlers.", "type": "number" }, "min": { "description": "Minimum memory used to execute event handlers.", "type": "number" }, "ninetyFivePercentile": { "description": "95% of the invocations took less memory than this field's value.", "type": "number" }, "ninetyNinePercentile": { "description": "99% of the invocations took less memory than this field's value.", "type": "number" }, "seventyFivePercentile": { "description": "75% of the invocations took less memory than this field's value.", "type": "number" }, "twentyFivePercentile": { "description": "25% of the invocations took less memory than this field's value.", "type": "number" } }, "x-akamai": { "file-path": "schemas/report-memory-usage.yaml" } }, "startDateTime": { "description": "Start date of the time period (ISO 8601).", "type": "string" } } } } }, "edgeWorkerId": { "description": "Unique identifier for an EdgeWorker.", "type": "integer" } }, "x-akamai": { "file-path": "schemas/report-4.yaml" } }, { "additionalProperties": false, "description": "Specifies execution and initialization times with percentiles, grouped by event handler for each EdgeWorker ID.", "title": "Report 5", "type": "object", "required": [ "edgeWorkerId", "data", "summaryStatistics" ], "properties": { "data": { "description": "Data points grouped by event handler and initialization mapping keys.", "type": "object", "additionalProperties": { "description": "Up to four event handler arrays and an init array for initialization data points.", "type": "array", "items": { "additionalProperties": false, "description": "Aggregated execution or initialization durations.", "type": "object", "required": [ "startDateTime", "edgeWorkerVersion", "invocations" ], "properties": { "edgeWorkerVersion": { "description": "The EdgeWorker version active when the event handler executed.", "type": "string" }, "execDuration": { "additionalProperties": false, "description": "Execution duration.", "type": "object", "required": [ "avg", "min", "max", "twentyFivePercentile", "fiftyPercentile", "seventyFivePercentile", "ninetyFivePercentile", "ninetyNinePercentile" ], "properties": { "avg": { "description": "Average clock time used to execute event handlers, in milliseconds.", "type": "number" }, "fiftyPercentile": { "description": "50% of the invocations took less execution time than this field's value, in milliseconds.", "type": "number" }, "max": { "description": "Maximum clock time used to execute event handlers, in milliseconds.", "type": "number" }, "min": { "description": "Minimum clock time used to execute event handlers, in milliseconds.", "type": "number" }, "ninetyFivePercentile": { "description": "95% of the invocations took less execution time than this field's value, in milliseconds.", "type": "number" }, "ninetyNinePercentile": { "description": "99% of the invocations took less execution time than this field's value, in milliseconds.", "type": "number" }, "seventyFivePercentile": { "description": "75% of the invocations took less execution time than this field's value, in milliseconds.", "type": "number" }, "twentyFivePercentile": { "description": "25% of the invocations took less execution time than this field's value, in milliseconds.", "type": "number" } }, "x-akamai": { "file-path": "schemas/report-exec-duration.yaml" } }, "initDuration": { "additionalProperties": false, "description": "Initialization duration.", "type": "object", "required": [ "avg", "min", "max", "twentyFivePercentile", "fiftyPercentile", "seventyFivePercentile", "ninetyFivePercentile", "ninetyNinePercentile" ], "properties": { "avg": { "description": "Average clock time used to initialize the event handlers, in milliseconds. The average is the sum of durations divided by the number of executions.", "type": "number" }, "fiftyPercentile": { "description": "50% of the invocations took less initialization time than this field's value, in milliseconds.", "type": "number" }, "max": { "description": "Maximum clock time used to initialize the event handlers, in milliseconds.", "type": "number" }, "min": { "description": "Minimum clock time used to initialize the event handlers, in milliseconds.", "type": "number" }, "ninetyFivePercentile": { "description": "95% of the invocations took less initialization time than this field's value, in milliseconds.", "type": "number" }, "ninetyNinePercentile": { "description": "99% of the invocations took less initialization time than this field's value, in milliseconds.", "type": "number" }, "seventyFivePercentile": { "description": "75% of the invocations took less initialization time than this field's value, in milliseconds.", "type": "number" }, "twentyFivePercentile": { "description": "25% of the invocations took less initialization time than this field's value, in milliseconds.", "type": "number" } }, "x-akamai": { "file-path": "schemas/report-init-duration.yaml" } }, "invocations": { "description": "Number of aggregated executions or initializations.", "type": "integer" }, "startDateTime": { "description": "Start date of the time period (ISO 8601).", "type": "string" } } } } }, "edgeWorkerId": { "description": "Unique identifier for an EdgeWorker.", "type": "integer" }, "summaryStatistics": { "additionalProperties": false, "description": "Execution and initialization time summary in percentiles.", "type": "object", "required": [ "init", "onClientRequest", "onClientResponse", "onOriginRequest", "onOriginResponse", "responseProvider", "totalExecTime" ], "properties": { "init": { "additionalProperties": false, "description": "Initialization time summary in percentiles.", "type": "object", "required": [ "twentyFivePercentile", "fiftyPercentile", "seventyFivePercentile", "ninetyFivePercentile", "ninetyNinePercentile" ], "properties": { "fiftyPercentile": { "description": "50% of the invocations took less time than this field's value, in milliseconds.", "type": "number" }, "ninetyFivePercentile": { "description": "95% of the invocations took less time than this field's value, in milliseconds.", "type": "number" }, "ninetyNinePercentile": { "description": "99% of the invocations took less time than this field's value, in milliseconds.", "type": "number" }, "seventyFivePercentile": { "description": "75% of the invocations took less time than this field's value, in milliseconds.", "type": "number" }, "twentyFivePercentile": { "description": "25% of the invocations took less time than this field's value, in milliseconds.", "type": "number" } }, "x-akamai": { "file-path": "schemas/report-exec-and-init-summary.yaml" } }, "onClientRequest": { "additionalProperties": false, "description": "Execution time summary in percentiles for all invocations of `onClientRequest`.", "type": "object", "required": [ "twentyFivePercentile", "fiftyPercentile", "seventyFivePercentile", "ninetyFivePercentile", "ninetyNinePercentile" ], "properties": { "fiftyPercentile": { "description": "50% of the invocations took less time than this field's value, in milliseconds.", "type": "number" }, "ninetyFivePercentile": { "description": "95% of the invocations took less time than this field's value, in milliseconds.", "type": "number" }, "ninetyNinePercentile": { "description": "99% of the invocations took less time than this field's value, in milliseconds.", "type": "number" }, "seventyFivePercentile": { "description": "75% of the invocations took less time than this field's value, in milliseconds.", "type": "number" }, "twentyFivePercentile": { "description": "25% of the invocations took less time than this field's value, in milliseconds.", "type": "number" } }, "x-akamai": { "file-path": "schemas/report-exec-and-init-summary.yaml" } }, "onClientResponse": { "additionalProperties": false, "description": "Execution time summary in percentiles for all invocations of `onClientResponse`.", "type": "object", "required": [ "twentyFivePercentile", "fiftyPercentile", "seventyFivePercentile", "ninetyFivePercentile", "ninetyNinePercentile" ], "properties": { "fiftyPercentile": { "description": "50% of the invocations took less time than this field's value, in milliseconds.", "type": "number" }, "ninetyFivePercentile": { "description": "95% of the invocations took less time than this field's value, in milliseconds.", "type": "number" }, "ninetyNinePercentile": { "description": "99% of the invocations took less time than this field's value, in milliseconds.", "type": "number" }, "seventyFivePercentile": { "description": "75% of the invocations took less time than this field's value, in milliseconds.", "type": "number" }, "twentyFivePercentile": { "description": "25% of the invocations took less time than this field's value, in milliseconds.", "type": "number" } }, "x-akamai": { "file-path": "schemas/report-exec-and-init-summary.yaml" } }, "onOriginRequest": { "additionalProperties": false, "description": "Execution time summary in percentiles for all invocations of `onOriginRequest`.", "type": "object", "required": [ "twentyFivePercentile", "fiftyPercentile", "seventyFivePercentile", "ninetyFivePercentile", "ninetyNinePercentile" ], "properties": { "fiftyPercentile": { "description": "50% of the invocations took less time than this field's value, in milliseconds.", "type": "number" }, "ninetyFivePercentile": { "description": "95% of the invocations took less time than this field's value, in milliseconds.", "type": "number" }, "ninetyNinePercentile": { "description": "99% of the invocations took less time than this field's value, in milliseconds.", "type": "number" }, "seventyFivePercentile": { "description": "75% of the invocations took less time than this field's value, in milliseconds.", "type": "number" }, "twentyFivePercentile": { "description": "25% of the invocations took less time than this field's value, in milliseconds.", "type": "number" } }, "x-akamai": { "file-path": "schemas/report-exec-and-init-summary.yaml" } }, "onOriginResponse": { "additionalProperties": false, "description": "Execution time summary in percentiles for all invocations of `onOriginResponse`.", "type": "object", "required": [ "twentyFivePercentile", "fiftyPercentile", "seventyFivePercentile", "ninetyFivePercentile", "ninetyNinePercentile" ], "properties": { "fiftyPercentile": { "description": "50% of the invocations took less time than this field's value, in milliseconds.", "type": "number" }, "ninetyFivePercentile": { "description": "95% of the invocations took less time than this field's value, in milliseconds.", "type": "number" }, "ninetyNinePercentile": { "description": "99% of the invocations took less time than this field's value, in milliseconds.", "type": "number" }, "seventyFivePercentile": { "description": "75% of the invocations took less time than this field's value, in milliseconds.", "type": "number" }, "twentyFivePercentile": { "description": "25% of the invocations took less time than this field's value, in milliseconds.", "type": "number" } }, "x-akamai": { "file-path": "schemas/report-exec-and-init-summary.yaml" } }, "responseProvider": { "additionalProperties": false, "description": "Execution time summary in percentiles for all invocations of `responseProvider`.", "type": "object", "required": [ "twentyFivePercentile", "fiftyPercentile", "seventyFivePercentile", "ninetyFivePercentile", "ninetyNinePercentile" ], "properties": { "fiftyPercentile": { "description": "50% of the invocations took less time than this field's value, in milliseconds.", "type": "number" }, "ninetyFivePercentile": { "description": "95% of the invocations took less time than this field's value, in milliseconds.", "type": "number" }, "ninetyNinePercentile": { "description": "99% of the invocations took less time than this field's value, in milliseconds.", "type": "number" }, "seventyFivePercentile": { "description": "75% of the invocations took less time than this field's value, in milliseconds.", "type": "number" }, "twentyFivePercentile": { "description": "25% of the invocations took less time than this field's value, in milliseconds.", "type": "number" } }, "x-akamai": { "file-path": "schemas/report-exec-and-init-summary.yaml" } }, "totalExecTime": { "additionalProperties": false, "description": "Execution time summary in percentiles for all five event handlers.", "type": "object", "required": [ "twentyFivePercentile", "fiftyPercentile", "seventyFivePercentile", "ninetyFivePercentile", "ninetyNinePercentile" ], "properties": { "fiftyPercentile": { "description": "50% of the invocations took less time than this field's value, in milliseconds.", "type": "number" }, "ninetyFivePercentile": { "description": "95% of the invocations took less time than this field's value, in milliseconds.", "type": "number" }, "ninetyNinePercentile": { "description": "99% of the invocations took less time than this field's value, in milliseconds.", "type": "number" }, "seventyFivePercentile": { "description": "75% of the invocations took less time than this field's value, in milliseconds.", "type": "number" }, "twentyFivePercentile": { "description": "25% of the invocations took less time than this field's value, in milliseconds.", "type": "number" } }, "x-akamai": { "file-path": "schemas/report-exec-and-init-summary.yaml" } } } } }, "x-akamai": { "file-path": "schemas/report-5.yaml" } }, { "additionalProperties": false, "description": "Specifies memory usages with percentiles, grouped by event handler for each EdgeWorker ID.", "title": "Report 6", "type": "object", "required": [ "edgeWorkerId", "data", "summaryStatistics" ], "properties": { "data": { "description": "Data points grouped by event handler mapping keys.", "type": "object", "additionalProperties": { "description": "Up to four event handler arrays.", "type": "array", "items": { "additionalProperties": false, "description": "Aggregated memory usage.", "type": "object", "required": [ "startDateTime", "edgeWorkerVersion", "memory", "invocations" ], "properties": { "edgeWorkerVersion": { "description": "The EdgeWorker version that was active during the execution of event handlers.", "type": "string" }, "invocations": { "description": "Number of aggregated executions.", "type": "integer" }, "memory": { "additionalProperties": false, "description": "Memory usage (bytes).", "type": "object", "required": [ "avg", "min", "max", "twentyFivePercentile", "fiftyPercentile", "seventyFivePercentile", "ninetyFivePercentile", "ninetyNinePercentile" ], "properties": { "avg": { "description": "Average memory used to execute event handlers.", "type": "number" }, "fiftyPercentile": { "description": "50% of the invocations took less memory than this field's value.", "type": "number" }, "max": { "description": "Maximum memory used to execute event handlers.", "type": "number" }, "min": { "description": "Minimum memory used to execute event handlers.", "type": "number" }, "ninetyFivePercentile": { "description": "95% of the invocations took less memory than this field's value.", "type": "number" }, "ninetyNinePercentile": { "description": "99% of the invocations took less memory than this field's value.", "type": "number" }, "seventyFivePercentile": { "description": "75% of the invocations took less memory than this field's value.", "type": "number" }, "twentyFivePercentile": { "description": "25% of the invocations took less memory than this field's value.", "type": "number" } }, "x-akamai": { "file-path": "schemas/report-memory-usage.yaml" } }, "startDateTime": { "description": "Start date of the time period (ISO 8601).", "type": "string" } } } } }, "edgeWorkerId": { "description": "Unique identifier for an EdgeWorker.", "type": "integer" }, "summaryStatistics": { "additionalProperties": false, "description": "Memory usage summary in percentiles by event handler.", "type": "object", "required": [ "onClientRequest", "onClientResponse", "onOriginRequest", "onOriginResponse", "responseProvider", "totalMemoryUsage" ], "properties": { "onClientRequest": { "additionalProperties": false, "description": "Memory usage summary in percentiles for all invocations of `onClientRequest`.", "type": "object", "required": [ "twentyFivePercentile", "fiftyPercentile", "seventyFivePercentile", "ninetyFivePercentile", "ninetyNinePercentile" ], "properties": { "fiftyPercentile": { "description": "50% of the invocations took less memory than this field's value.", "type": "number" }, "ninetyFivePercentile": { "description": "95% of the invocations took less memory than this field's value.", "type": "number" }, "ninetyNinePercentile": { "description": "99% of the invocations took less memory than this field's value.", "type": "number" }, "seventyFivePercentile": { "description": "75% of the invocations took less memory than this field's value.", "type": "number" }, "twentyFivePercentile": { "description": "25% of the invocations took less memory than this field's value.", "type": "number" } }, "x-akamai": { "file-path": "schemas/report-memory-usage-summary.yaml" } }, "onClientResponse": { "additionalProperties": false, "description": "Memory usage summary in percentiles for all invocations of `onClientResponse`.", "type": "object", "required": [ "twentyFivePercentile", "fiftyPercentile", "seventyFivePercentile", "ninetyFivePercentile", "ninetyNinePercentile" ], "properties": { "fiftyPercentile": { "description": "50% of the invocations took less memory than this field's value.", "type": "number" }, "ninetyFivePercentile": { "description": "95% of the invocations took less memory than this field's value.", "type": "number" }, "ninetyNinePercentile": { "description": "99% of the invocations took less memory than this field's value.", "type": "number" }, "seventyFivePercentile": { "description": "75% of the invocations took less memory than this field's value.", "type": "number" }, "twentyFivePercentile": { "description": "25% of the invocations took less memory than this field's value.", "type": "number" } }, "x-akamai": { "file-path": "schemas/report-memory-usage-summary.yaml" } }, "onOriginRequest": { "additionalProperties": false, "description": "Memory usage summary in percentiles for all invocations of `onOriginRequest`.", "type": "object", "required": [ "twentyFivePercentile", "fiftyPercentile", "seventyFivePercentile", "ninetyFivePercentile", "ninetyNinePercentile" ], "properties": { "fiftyPercentile": { "description": "50% of the invocations took less memory than this field's value.", "type": "number" }, "ninetyFivePercentile": { "description": "95% of the invocations took less memory than this field's value.", "type": "number" }, "ninetyNinePercentile": { "description": "99% of the invocations took less memory than this field's value.", "type": "number" }, "seventyFivePercentile": { "description": "75% of the invocations took less memory than this field's value.", "type": "number" }, "twentyFivePercentile": { "description": "25% of the invocations took less memory than this field's value.", "type": "number" } }, "x-akamai": { "file-path": "schemas/report-memory-usage-summary.yaml" } }, "onOriginResponse": { "additionalProperties": false, "description": "Memory usage summary in percentiles for all invocations of `onOriginResponse`.", "type": "object", "required": [ "twentyFivePercentile", "fiftyPercentile", "seventyFivePercentile", "ninetyFivePercentile", "ninetyNinePercentile" ], "properties": { "fiftyPercentile": { "description": "50% of the invocations took less memory than this field's value.", "type": "number" }, "ninetyFivePercentile": { "description": "95% of the invocations took less memory than this field's value.", "type": "number" }, "ninetyNinePercentile": { "description": "99% of the invocations took less memory than this field's value.", "type": "number" }, "seventyFivePercentile": { "description": "75% of the invocations took less memory than this field's value.", "type": "number" }, "twentyFivePercentile": { "description": "25% of the invocations took less memory than this field's value.", "type": "number" } }, "x-akamai": { "file-path": "schemas/report-memory-usage-summary.yaml" } }, "responseProvider": { "additionalProperties": false, "description": "Memory usage summary in percentiles for all invocations of `responseProvider`.", "type": "object", "required": [ "twentyFivePercentile", "fiftyPercentile", "seventyFivePercentile", "ninetyFivePercentile", "ninetyNinePercentile" ], "properties": { "fiftyPercentile": { "description": "50% of the invocations took less memory than this field's value.", "type": "number" }, "ninetyFivePercentile": { "description": "95% of the invocations took less memory than this field's value.", "type": "number" }, "ninetyNinePercentile": { "description": "99% of the invocations took less memory than this field's value.", "type": "number" }, "seventyFivePercentile": { "description": "75% of the invocations took less memory than this field's value.", "type": "number" }, "twentyFivePercentile": { "description": "25% of the invocations took less memory than this field's value.", "type": "number" } }, "x-akamai": { "file-path": "schemas/report-memory-usage-summary.yaml" } }, "totalMemoryUsage": { "additionalProperties": false, "description": "Memory usage summary in percentiles for all five event handlers.", "type": "object", "required": [ "twentyFivePercentile", "fiftyPercentile", "seventyFivePercentile", "ninetyFivePercentile", "ninetyNinePercentile" ], "properties": { "fiftyPercentile": { "description": "50% of the invocations took less memory than this field's value.", "type": "number" }, "ninetyFivePercentile": { "description": "95% of the invocations took less memory than this field's value.", "type": "number" }, "ninetyNinePercentile": { "description": "99% of the invocations took less memory than this field's value.", "type": "number" }, "seventyFivePercentile": { "description": "75% of the invocations took less memory than this field's value.", "type": "number" }, "twentyFivePercentile": { "description": "25% of the invocations took less memory than this field's value.", "type": "number" } }, "x-akamai": { "file-path": "schemas/report-memory-usage-summary.yaml" } } } } }, "x-akamai": { "file-path": "schemas/report-6.yaml" } } ] } } ] }, "description": { "description": "Description of the EdgeWorker report.", "minLength": 1, "type": "string" }, "end": { "description": "ISO 8601 timestamp indicating the end time of the EdgeWorker report.", "format": "date-time", "type": "string" }, "name": { "description": "Name of the EdgeWorker report.", "minLength": 1, "type": "string" }, "reportId": { "description": "Unique identifier of the EdgeWorker report.", "minimum": 1, "type": "integer" }, "start": { "description": "ISO 8601 timestamp indicating the start time of the EdgeWorker report.", "format": "date-time", "type": "string" }, "unavailable": { "description": "Boolean stating if the report is available or not.", "type": "boolean" } }, "x-akamai": { "file-path": "schemas/report-get-200.yaml" } } } }, "x-akamai": { "file-path": "schemas/reports-get-200.yaml" } } } } } }, "parameters": [ { "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).", "example": "{{accountSwitchKey}}", "in": "query", "name": "accountSwitchKey", "required": false, "schema": { "example": "1-5C0YLB:1-8BYUX", "type": "string" } } ] } }, "/reports/{reportId}": { "get": { "description": "View details for a specific EdgeWorker.", "operationId": "get-report", "summary": "Akamai Get an EdgeWorker Report", "tags": [ "Reports" ], "externalDocs": { "description": "See documentation for this operation in Akamai's EdgeWorkers API", "url": "https://techdocs.akamai.com/edgeworkers/reference/get-report" }, "responses": { "200": { "description": "This section describes attributes of an EdgeWorker report.", "content": { "application/json": { "example": { "description": "This report lists execution and initialization times with percentiles, grouped by EdgeWorker ID and event handler.", "end": "2022-04-19T15:04:39Z", "name": "Initialization and execution times by EdgeWorker ID and event handler", "reportId": 5, "start": "2022-04-18T15:04:39Z", "summaryStatistics": { "init": { "fiftyPercentile": 0.1, "ninetyFivePercentile": 0.5, "ninetyNinePercentile": 0.5, "seventyFivePercentile": 0.5, "twentyFivePercentile": 0.1 }, "onClientRequest": { "fiftyPercentile": 5, "ninetyFivePercentile": 20, "ninetyNinePercentile": 100, "seventyFivePercentile": 7, "twentyFivePercentile": 0.5 }, "onClientResponse": { "fiftyPercentile": 7, "ninetyFivePercentile": 20, "ninetyNinePercentile": 100, "seventyFivePercentile": 10, "twentyFivePercentile": 0.1 }, "onOriginRequest": { "fiftyPercentile": 8, "ninetyFivePercentile": 25, "ninetyNinePercentile": 70, "seventyFivePercentile": 10, "twentyFivePercentile": 0.1 }, "onOriginResponse": { "fiftyPercentile": 7, "ninetyFivePercentile": 30, "ninetyNinePercentile": 100, "seventyFivePercentile": 10, "twentyFivePercentile": 0.4 }, "responseProvider": {}, "totalExecTime": { "fiftyPercentile": 3, "ninetyFivePercentile": 20, "ninetyNinePercentile": 100, "seventyFivePercentile": 7, "twentyFivePercentile": 0.5 } }, "data": [ { "edgeWorkerId": 37017, "data": { "init": [ { "edgeWorkerVersion": "0.8", "invocations": 1, "startDateTime": "2022-04-18T15:04:39Z", "initDuration": { "avg": 4.192, "fiftyPercentile": 1, "max": 4.192, "min": 4.192, "ninetyFivePercentile": 7, "ninetyNinePercentile": 20, "seventyFivePercentile": 3, "twentyFivePercentile": 0.5 } } ], "onClientRequest": [ { "edgeWorkerVersion": "1", "invocations": 3, "startDateTime": "2022-04-18T15:35:00Z", "execDuration": { "avg": 0.128, "fiftyPercentile": 1, "max": 0.217, "min": 0.077, "ninetyFivePercentile": 7, "ninetyNinePercentile": 10, "seventyFivePercentile": 3, "twentyFivePercentile": 0.1 } } ], "onClientResponse": [ { "edgeWorkerVersion": "1", "invocations": 3, "startDateTime": "2022-04-18T15:04:39Z", "execDuration": { "avg": 0.11, "fiftyPercentile": 1, "max": 0.16, "min": 0.071, "ninetyFivePercentile": 10, "ninetyNinePercentile": 20, "seventyFivePercentile": 3, "twentyFivePercentile": 0.1 } } ], "onOriginRequest": [ { "edgeWorkerVersion": "1", "invocations": 3, "startDateTime": "2022-04-18T15:04:39Z", "execDuration": { "avg": 0.138, "fiftyPercentile": 1, "max": 0.254, "min": 0.073, "ninetyFivePercentile": 7, "ninetyNinePercentile": 20, "seventyFivePercentile": 3, "twentyFivePercentile": 0.5 } } ], "onOriginResponse": [ { "edgeWorkerVersion": "1", "invocations": 3, "startDateTime": "2022-04-19T12:35:00Z", "execDuration": { "avg": 0.105, "fiftyPercentile": 1, "max": 0.175, "min": 0.069, "ninetyFivePercentile": 7, "ninetyNinePercentile": 7, "seventyFivePercentile": 1, "twentyFivePercentile": 0 } } ] }, "summaryStatistics": { "init": { "fiftyPercentile": 0.1, "ninetyFivePercentile": 0.5, "ninetyNinePercentile": 0.5, "seventyFivePercentile": 0.5, "twentyFivePercentile": 0.1 }, "onClientRequest": { "fiftyPercentile": 5, "ninetyFivePercentile": 20, "ninetyNinePercentile": 100, "seventyFivePercentile": 7, "twentyFivePercentile": 0.5 }, "onClientResponse": { "fiftyPercentile": 7, "ninetyFivePercentile": 20, "ninetyNinePercentile": 100, "seventyFivePercentile": 10, "twentyFivePercentile": 0.1 }, "onOriginRequest": { "fiftyPercentile": 8, "ninetyFivePercentile": 25, "ninetyNinePercentile": 70, "seventyFivePercentile": 10, "twentyFivePercentile": 0.1 }, "onOriginResponse": { "fiftyPercentile": 7, "ninetyFivePercentile": 30, "ninetyNinePercentile": 100, "seventyFivePercentile": 10, "twentyFivePercentile": 0.4 }, "responseProvider": {}, "totalExecTime": { "fiftyPercentile": 3, "ninetyFivePercentile": 20, "ninetyNinePercentile": 100, "seventyFivePercentile": 7, "twentyFivePercentile": 0.5 } } } ] }, "schema": { "additionalProperties": false, "type": "object", "properties": { "data": { "description": "Object containing data points of the EdgeWorker report.", "oneOf": [ { "title": "Single report", "oneOf": [ { "additionalProperties": false, "description": "Specifies summary data for each EdgeWorker's usage.", "title": "Report 1", "type": "object", "required": [ "invocations", "successes", "errors", "execDuration", "initDuration", "memory" ], "properties": { "errors": { "additionalProperties": false, "description": "Failed event handler executions.", "type": "object", "required": [ "total" ], "properties": { "total": { "description": "Total number of failed executions.", "type": "integer" } } }, "execDuration": { "additionalProperties": false, "description": "Execution duration.", "type": "object", "required": [ "avg", "min", "max", "twentyFivePercentile", "fiftyPercentile", "seventyFivePercentile", "ninetyFivePercentile", "ninetyNinePercentile" ], "properties": { "avg": { "description": "Average clock time used to execute event handlers, in milliseconds.", "type": "number" }, "fiftyPercentile": { "description": "50% of the invocations took less execution time than this field's value, in milliseconds.", "type": "number" }, "max": { "description": "Maximum clock time used to execute event handlers, in milliseconds.", "type": "number" }, "min": { "description": "Minimum clock time used to execute event handlers, in milliseconds.", "type": "number" }, "ninetyFivePercentile": { "description": "95% of the invocations took less execution time than this field's value, in milliseconds.", "type": "number" }, "ninetyNinePercentile": { "description": "99% of the invocations took less execution time than this field's value, in milliseconds.", "type": "number" }, "seventyFivePercentile": { "description": "75% of the invocations took less execution time than this field's value, in milliseconds.", "type": "number" }, "twentyFivePercentile": { "description": "25% of the invocations took less execution time than this field's value, in milliseconds.", "type": "number" } }, "x-akamai": { "file-path": "schemas/report-exec-duration.yaml" } }, "initDuration": { "additionalProperties": false, "description": "Initialization duration.", "type": "object", "required": [ "avg", "min", "max", "twentyFivePercentile", "fiftyPercentile", "seventyFivePercentile", "ninetyFivePercentile", "ninetyNinePercentile" ], "properties": { "avg": { "description": "Average clock time used to initialize the event handlers, in milliseconds. The average is the sum of durations divided by the number of executions.", "type": "number" }, "fiftyPercentile": { "description": "50% of the invocations took less initialization time than this field's value, in milliseconds.", "type": "number" }, "max": { "description": "Maximum clock time used to initialize the event handlers, in milliseconds.", "type": "number" }, "min": { "description": "Minimum clock time used to initialize the event handlers, in milliseconds.", "type": "number" }, "ninetyFivePercentile": { "description": "95% of the invocations took less initialization time than this field's value, in milliseconds.", "type": "number" }, "ninetyNinePercentile": { "description": "99% of the invocations took less initialization time than this field's value, in milliseconds.", "type": "number" }, "seventyFivePercentile": { "description": "75% of the invocations took less initialization time than this field's value, in milliseconds.", "type": "number" }, "twentyFivePercentile": { "description": "25% of the invocations took less initialization time than this field's value, in milliseconds.", "type": "number" } }, "x-akamai": { "file-path": "schemas/report-init-duration.yaml" } }, "invocations": { "additionalProperties": false, "description": "Number of executions.", "type": "object", "required": [ "total" ], "properties": { "total": { "description": "Total number of executions.", "type": "integer" } } }, "memory": { "additionalProperties": false, "description": "Memory usage.", "type": "object", "required": [ "avg", "min", "max", "twentyFivePercentile", "fiftyPercentile", "seventyFivePercentile", "ninetyFivePercentile", "ninetyNinePercentile" ], "properties": { "avg": { "description": "Average memory used to execute event handlers.", "type": "number" }, "fiftyPercentile": { "description": "50% of the invocations took less memory than this field's value.", "type": "number" }, "max": { "description": "Maximum memory used to execute event handlers.", "type": "number" }, "min": { "description": "Minimum memory used to execute event handlers.", "type": "number" }, "ninetyFivePercentile": { "description": "95% of the invocations took less memory than this field's value.", "type": "number" }, "ninetyNinePercentile": { "description": "99% of the invocations took less memory than this field's value.", "type": "number" }, "seventyFivePercentile": { "description": "75% of the invocations took less memory than this field's value.", "type": "number" }, "twentyFivePercentile": { "description": "25% of the invocations took less memory than this field's value.", "type": "number" } }, "x-akamai": { "file-path": "schemas/report-memory-usage.yaml" } }, "successes": { "additionalProperties": false, "description": "Successful event handler executions.", "type": "object", "required": [ "total" ], "properties": { "total": { "description": "Total number of successful executions.", "type": "integer" } } } }, "x-akamai": { "file-path": "schemas/report-1.yaml" } }, { "additionalProperties": false, "description": "Specifies execution and initialization times, grouped by event handler for each EdgeWorker.", "title": "Report 2", "type": "object", "required": [ "edgeWorkerId", "data" ], "properties": { "data": { "description": "Data points grouped by event handler and initialization mapping keys.", "type": "object", "additionalProperties": { "description": "Up to four event handler arrays and an init array for initialization data points.", "type": "array", "items": { "additionalProperties": false, "description": "Aggregated execution or initialization durations.", "type": "object", "required": [ "startDateTime", "edgeWorkerVersion", "invocations" ], "properties": { "edgeWorkerVersion": { "description": "The EdgeWorker version that was active during the execution of event handlers.", "type": "string" }, "execDuration": { "additionalProperties": false, "description": "Execution duration.", "type": "object", "required": [ "avg", "min", "max", "twentyFivePercentile", "fiftyPercentile", "seventyFivePercentile", "ninetyFivePercentile", "ninetyNinePercentile" ], "properties": { "avg": { "description": "Average clock time used to execute event handlers, in milliseconds.", "type": "number" }, "fiftyPercentile": { "description": "50% of the invocations took less execution time than this field's value, in milliseconds.", "type": "number" }, "max": { "description": "Maximum clock time used to execute event handlers, in milliseconds.", "type": "number" }, "min": { "description": "Minimum clock time used to execute event handlers, in milliseconds.", "type": "number" }, "ninetyFivePercentile": { "description": "95% of the invocations took less execution time than this field's value, in milliseconds.", "type": "number" }, "ninetyNinePercentile": { "description": "99% of the invocations took less execution time than this field's value, in milliseconds.", "type": "number" }, "seventyFivePercentile": { "description": "75% of the invocations took less execution time than this field's value, in milliseconds.", "type": "number" }, "twentyFivePercentile": { "description": "25% of the invocations took less execution time than this field's value, in milliseconds.", "type": "number" } }, "x-akamai": { "file-path": "schemas/report-exec-duration.yaml" } }, "initDuration": { "additionalProperties": false, "description": "Initialization duration.", "type": "object", "required": [ "avg", "min", "max", "twentyFivePercentile", "fiftyPercentile", "seventyFivePercentile", "ninetyFivePercentile", "ninetyNinePercentile" ], "properties": { "avg": { "description": "Average clock time used to initialize the event handlers, in milliseconds. The average is the sum of durations divided by the number of executions.", "type": "number" }, "fiftyPercentile": { "description": "50% of the invocations took less initialization time than this field's value, in milliseconds.", "type": "number" }, "max": { "description": "Maximum clock time used to initialize the event handlers, in milliseconds.", "type": "number" }, "min": { "description": "Minimum clock time used to initialize the event handlers, in milliseconds.", "type": "number" }, "ninetyFivePercentile": { "description": "95% of the invocations took less initialization time than this field's value, in milliseconds.", "type": "number" }, "ninetyNinePercentile": { "description": "99% of the invocations took less initialization time than this field's value, in milliseconds.", "type": "number" }, "seventyFivePercentile": { "description": "75% of the invocations took less initialization time than this field's value, in milliseconds.", "type": "number" }, "twentyFivePercentile": { "description": "25% of the invocations took less initialization time than this field's value, in milliseconds.", "type": "number" } }, "x-akamai": { "file-path": "schemas/report-init-duration.yaml" } }, "invocations": { "description": "Number of aggregated executions or initializations.", "type": "integer" }, "startDateTime": { "description": "Start date of the time period (ISO 8601).", "type": "string" } } } } }, "edgeWorkerId": { "description": "Unique identifier for an EdgeWorker.", "type": "integer" } }, "x-akamai": { "file-path": "schemas/report-2.yaml" } }, { "additionalProperties": false, "description": "Specifies execution success and error statuses, grouped by event handler for each EdgeWorker.", "title": "Report 3", "type": "object", "required": [ "edgeWorkerId", "data" ], "properties": { "data": { "description": "Data points grouped by event handler mapping keys.", "type": "object", "additionalProperties": { "description": "Up to four event handler arrays.", "type": "array", "items": { "additionalProperties": false, "description": "Aggregated execution status.", "type": "object", "required": [ "startDateTime", "edgeWorkerVersion", "status", "invocations" ], "properties": { "edgeWorkerVersion": { "description": "The EdgeWorker version that was active during the execution of event handlers.", "type": "string" }, "invocations": { "description": "Number of aggregated executions.", "type": "integer" }, "startDateTime": { "description": "Start date of the time period (ISO 8601).", "type": "string" }, "status": { "description": "Execution status.", "type": "string" } } } } }, "edgeWorkerId": { "description": "Unique identifier for an EdgeWorker.", "type": "integer" } }, "x-akamai": { "file-path": "schemas/report-3.yaml" } }, { "additionalProperties": false, "description": "Data array of EdgeWorker report ID 4.", "title": "Report 4", "type": "object", "required": [ "edgeWorkerId", "data" ], "properties": { "data": { "description": "Data points grouped by event handler mapping keys.", "type": "object", "additionalProperties": { "description": "Up to four event handler arrays.", "type": "array", "items": { "additionalProperties": false, "description": "Aggregated memory usage.", "type": "object", "required": [ "startDateTime", "edgeWorkerVersion", "memory", "invocations" ], "properties": { "edgeWorkerVersion": { "description": "The EdgeWorker version that was active during the execution of event handlers.", "type": "string" }, "invocations": { "description": "Number of aggregated executions.", "type": "integer" }, "memory": { "additionalProperties": false, "description": "Memory usage.", "type": "object", "required": [ "avg", "min", "max", "twentyFivePercentile", "fiftyPercentile", "seventyFivePercentile", "ninetyFivePercentile", "ninetyNinePercentile" ], "properties": { "avg": { "description": "Average memory used to execute event handlers.", "type": "number" }, "fiftyPercentile": { "description": "50% of the invocations took less memory than this field's value.", "type": "number" }, "max": { "description": "Maximum memory used to execute event handlers.", "type": "number" }, "min": { "description": "Minimum memory used to execute event handlers.", "type": "number" }, "ninetyFivePercentile": { "description": "95% of the invocations took less memory than this field's value.", "type": "number" }, "ninetyNinePercentile": { "description": "99% of the invocations took less memory than this field's value.", "type": "number" }, "seventyFivePercentile": { "description": "75% of the invocations took less memory than this field's value.", "type": "number" }, "twentyFivePercentile": { "description": "25% of the invocations took less memory than this field's value.", "type": "number" } }, "x-akamai": { "file-path": "schemas/report-memory-usage.yaml" } }, "startDateTime": { "description": "Start date of the time period (ISO 8601).", "type": "string" } } } } }, "edgeWorkerId": { "description": "Unique identifier for an EdgeWorker.", "type": "integer" } }, "x-akamai": { "file-path": "schemas/report-4.yaml" } }, { "additionalProperties": false, "description": "Specifies execution and initialization times with percentiles, grouped by event handler for each EdgeWorker ID.", "title": "Report 5", "type": "object", "required": [ "edgeWorkerId", "data", "summaryStatistics" ], "properties": { "data": { "description": "Data points grouped by event handler and initialization mapping keys.", "type": "object", "additionalProperties": { "description": "Up to four event handler arrays and an init array for initialization data points.", "type": "array", "items": { "additionalProperties": false, "description": "Aggregated execution or initialization durations.", "type": "object", "required": [ "startDateTime", "edgeWorkerVersion", "invocations" ], "properties": { "edgeWorkerVersion": { "description": "The EdgeWorker version active when the event handler executed.", "type": "string" }, "execDuration": { "additionalProperties": false, "description": "Execution duration.", "type": "object", "required": [ "avg", "min", "max", "twentyFivePercentile", "fiftyPercentile", "seventyFivePercentile", "ninetyFivePercentile", "ninetyNinePercentile" ], "properties": { "avg": { "description": "Average clock time used to execute event handlers, in milliseconds.", "type": "number" }, "fiftyPercentile": { "description": "50% of the invocations took less execution time than this field's value, in milliseconds.", "type": "number" }, "max": { "description": "Maximum clock time used to execute event handlers, in milliseconds.", "type": "number" }, "min": { "description": "Minimum clock time used to execute event handlers, in milliseconds.", "type": "number" }, "ninetyFivePercentile": { "description": "95% of the invocations took less execution time than this field's value, in milliseconds.", "type": "number" }, "ninetyNinePercentile": { "description": "99% of the invocations took less execution time than this field's value, in milliseconds.", "type": "number" }, "seventyFivePercentile": { "description": "75% of the invocations took less execution time than this field's value, in milliseconds.", "type": "number" }, "twentyFivePercentile": { "description": "25% of the invocations took less execution time than this field's value, in milliseconds.", "type": "number" } }, "x-akamai": { "file-path": "schemas/report-exec-duration.yaml" } }, "initDuration": { "additionalProperties": false, "description": "Initialization duration.", "type": "object", "required": [ "avg", "min", "max", "twentyFivePercentile", "fiftyPercentile", "seventyFivePercentile", "ninetyFivePercentile", "ninetyNinePercentile" ], "properties": { "avg": { "description": "Average clock time used to initialize the event handlers, in milliseconds. The average is the sum of durations divided by the number of executions.", "type": "number" }, "fiftyPercentile": { "description": "50% of the invocations took less initialization time than this field's value, in milliseconds.", "type": "number" }, "max": { "description": "Maximum clock time used to initialize the event handlers, in milliseconds.", "type": "number" }, "min": { "description": "Minimum clock time used to initialize the event handlers, in milliseconds.", "type": "number" }, "ninetyFivePercentile": { "description": "95% of the invocations took less initialization time than this field's value, in milliseconds.", "type": "number" }, "ninetyNinePercentile": { "description": "99% of the invocations took less initialization time than this field's value, in milliseconds.", "type": "number" }, "seventyFivePercentile": { "description": "75% of the invocations took less initialization time than this field's value, in milliseconds.", "type": "number" }, "twentyFivePercentile": { "description": "25% of the invocations took less initialization time than this field's value, in milliseconds.", "type": "number" } }, "x-akamai": { "file-path": "schemas/report-init-duration.yaml" } }, "invocations": { "description": "Number of aggregated executions or initializations.", "type": "integer" }, "startDateTime": { "description": "Start date of the time period (ISO 8601).", "type": "string" } } } } }, "edgeWorkerId": { "description": "Unique identifier for an EdgeWorker.", "type": "integer" }, "summaryStatistics": { "additionalProperties": false, "description": "Execution and initialization time summary in percentiles.", "type": "object", "required": [ "init", "onClientRequest", "onClientResponse", "onOriginRequest", "onOriginResponse", "responseProvider", "totalExecTime" ], "properties": { "init": { "additionalProperties": false, "description": "Initialization time summary in percentiles.", "type": "object", "required": [ "twentyFivePercentile", "fiftyPercentile", "seventyFivePercentile", "ninetyFivePercentile", "ninetyNinePercentile" ], "properties": { "fiftyPercentile": { "description": "50% of the invocations took less time than this field's value, in milliseconds.", "type": "number" }, "ninetyFivePercentile": { "description": "95% of the invocations took less time than this field's value, in milliseconds.", "type": "number" }, "ninetyNinePercentile": { "description": "99% of the invocations took less time than this field's value, in milliseconds.", "type": "number" }, "seventyFivePercentile": { "description": "75% of the invocations took less time than this field's value, in milliseconds.", "type": "number" }, "twentyFivePercentile": { "description": "25% of the invocations took less time than this field's value, in milliseconds.", "type": "number" } }, "x-akamai": { "file-path": "schemas/report-exec-and-init-summary.yaml" } }, "onClientRequest": { "additionalProperties": false, "description": "Execution time summary in percentiles for all invocations of `onClientRequest`.", "type": "object", "required": [ "twentyFivePercentile", "fiftyPercentile", "seventyFivePercentile", "ninetyFivePercentile", "ninetyNinePercentile" ], "properties": { "fiftyPercentile": { "description": "50% of the invocations took less time than this field's value, in milliseconds.", "type": "number" }, "ninetyFivePercentile": { "description": "95% of the invocations took less time than this field's value, in milliseconds.", "type": "number" }, "ninetyNinePercentile": { "description": "99% of the invocations took less time than this field's value, in milliseconds.", "type": "number" }, "seventyFivePercentile": { "description": "75% of the invocations took less time than this field's value, in milliseconds.", "type": "number" }, "twentyFivePercentile": { "description": "25% of the invocations took less time than this field's value, in milliseconds.", "type": "number" } }, "x-akamai": { "file-path": "schemas/report-exec-and-init-summary.yaml" } }, "onClientResponse": { "additionalProperties": false, "description": "Execution time summary in percentiles for all invocations of `onClientResponse`.", "type": "object", "required": [ "twentyFivePercentile", "fiftyPercentile", "seventyFivePercentile", "ninetyFivePercentile", "ninetyNinePercentile" ], "properties": { "fiftyPercentile": { "description": "50% of the invocations took less time than this field's value, in milliseconds.", "type": "number" }, "ninetyFivePercentile": { "description": "95% of the invocations took less time than this field's value, in milliseconds.", "type": "number" }, "ninetyNinePercentile": { "description": "99% of the invocations took less time than this field's value, in milliseconds.", "type": "number" }, "seventyFivePercentile": { "description": "75% of the invocations took less time than this field's value, in milliseconds.", "type": "number" }, "twentyFivePercentile": { "description": "25% of the invocations took less time than this field's value, in milliseconds.", "type": "number" } }, "x-akamai": { "file-path": "schemas/report-exec-and-init-summary.yaml" } }, "onOriginRequest": { "additionalProperties": false, "description": "Execution time summary in percentiles for all invocations of `onOriginRequest`.", "type": "object", "required": [ "twentyFivePercentile", "fiftyPercentile", "seventyFivePercentile", "ninetyFivePercentile", "ninetyNinePercentile" ], "properties": { "fiftyPercentile": { "description": "50% of the invocations took less time than this field's value, in milliseconds.", "type": "number" }, "ninetyFivePercentile": { "description": "95% of the invocations took less time than this field's value, in milliseconds.", "type": "number" }, "ninetyNinePercentile": { "description": "99% of the invocations took less time than this field's value, in milliseconds.", "type": "number" }, "seventyFivePercentile": { "description": "75% of the invocations took less time than this field's value, in milliseconds.", "type": "number" }, "twentyFivePercentile": { "description": "25% of the invocations took less time than this field's value, in milliseconds.", "type": "number" } }, "x-akamai": { "file-path": "schemas/report-exec-and-init-summary.yaml" } }, "onOriginResponse": { "additionalProperties": false, "description": "Execution time summary in percentiles for all invocations of `onOriginResponse`.", "type": "object", "required": [ "twentyFivePercentile", "fiftyPercentile", "seventyFivePercentile", "ninetyFivePercentile", "ninetyNinePercentile" ], "properties": { "fiftyPercentile": { "description": "50% of the invocations took less time than this field's value, in milliseconds.", "type": "number" }, "ninetyFivePercentile": { "description": "95% of the invocations took less time than this field's value, in milliseconds.", "type": "number" }, "ninetyNinePercentile": { "description": "99% of the invocations took less time than this field's value, in milliseconds.", "type": "number" }, "seventyFivePercentile": { "description": "75% of the invocations took less time than this field's value, in milliseconds.", "type": "number" }, "twentyFivePercentile": { "description": "25% of the invocations took less time than this field's value, in milliseconds.", "type": "number" } }, "x-akamai": { "file-path": "schemas/report-exec-and-init-summary.yaml" } }, "responseProvider": { "additionalProperties": false, "description": "Execution time summary in percentiles for all invocations of `responseProvider`.", "type": "object", "required": [ "twentyFivePercentile", "fiftyPercentile", "seventyFivePercentile", "ninetyFivePercentile", "ninetyNinePercentile" ], "properties": { "fiftyPercentile": { "description": "50% of the invocations took less time than this field's value, in milliseconds.", "type": "number" }, "ninetyFivePercentile": { "description": "95% of the invocations took less time than this field's value, in milliseconds.", "type": "number" }, "ninetyNinePercentile": { "description": "99% of the invocations took less time than this field's value, in milliseconds.", "type": "number" }, "seventyFivePercentile": { "description": "75% of the invocations took less time than this field's value, in milliseconds.", "type": "number" }, "twentyFivePercentile": { "description": "25% of the invocations took less time than this field's value, in milliseconds.", "type": "number" } }, "x-akamai": { "file-path": "schemas/report-exec-and-init-summary.yaml" } }, "totalExecTime": { "additionalProperties": false, "description": "Execution time summary in percentiles for all five event handlers.", "type": "object", "required": [ "twentyFivePercentile", "fiftyPercentile", "seventyFivePercentile", "ninetyFivePercentile", "ninetyNinePercentile" ], "properties": { "fiftyPercentile": { "description": "50% of the invocations took less time than this field's value, in milliseconds.", "type": "number" }, "ninetyFivePercentile": { "description": "95% of the invocations took less time than this field's value, in milliseconds.", "type": "number" }, "ninetyNinePercentile": { "description": "99% of the invocations took less time than this field's value, in milliseconds.", "type": "number" }, "seventyFivePercentile": { "description": "75% of the invocations took less time than this field's value, in milliseconds.", "type": "number" }, "twentyFivePercentile": { "description": "25% of the invocations took less time than this field's value, in milliseconds.", "type": "number" } }, "x-akamai": { "file-path": "schemas/report-exec-and-init-summary.yaml" } } } } }, "x-akamai": { "file-path": "schemas/report-5.yaml" } }, { "additionalProperties": false, "description": "Specifies memory usages with percentiles, grouped by event handler for each EdgeWorker ID.", "title": "Report 6", "type": "object", "required": [ "edgeWorkerId", "data", "summaryStatistics" ], "properties": { "data": { "description": "Data points grouped by event handler mapping keys.", "type": "object", "additionalProperties": { "description": "Up to four event handler arrays.", "type": "array", "items": { "additionalProperties": false, "description": "Aggregated memory usage.", "type": "object", "required": [ "startDateTime", "edgeWorkerVersion", "memory", "invocations" ], "properties": { "edgeWorkerVersion": { "description": "The EdgeWorker version that was active during the execution of event handlers.", "type": "string" }, "invocations": { "description": "Number of aggregated executions.", "type": "integer" }, "memory": { "additionalProperties": false, "description": "Memory usage (bytes).", "type": "object", "required": [ "avg", "min", "max", "twentyFivePercentile", "fiftyPercentile", "seventyFivePercentile", "ninetyFivePercentile", "ninetyNinePercentile" ], "properties": { "avg": { "description": "Average memory used to execute event handlers.", "type": "number" }, "fiftyPercentile": { "description": "50% of the invocations took less memory than this field's value.", "type": "number" }, "max": { "description": "Maximum memory used to execute event handlers.", "type": "number" }, "min": { "description": "Minimum memory used to execute event handlers.", "type": "number" }, "ninetyFivePercentile": { "description": "95% of the invocations took less memory than this field's value.", "type": "number" }, "ninetyNinePercentile": { "description": "99% of the invocations took less memory than this field's value.", "type": "number" }, "seventyFivePercentile": { "description": "75% of the invocations took less memory than this field's value.", "type": "number" }, "twentyFivePercentile": { "description": "25% of the invocations took less memory than this field's value.", "type": "number" } }, "x-akamai": { "file-path": "schemas/report-memory-usage.yaml" } }, "startDateTime": { "description": "Start date of the time period (ISO 8601).", "type": "string" } } } } }, "edgeWorkerId": { "description": "Unique identifier for an EdgeWorker.", "type": "integer" }, "summaryStatistics": { "additionalProperties": false, "description": "Memory usage summary in percentiles by event handler.", "type": "object", "required": [ "onClientRequest", "onClientResponse", "onOriginRequest", "onOriginResponse", "responseProvider", "totalMemoryUsage" ], "properties": { "onClientRequest": { "additionalProperties": false, "description": "Memory usage summary in percentiles for all invocations of `onClientRequest`.", "type": "object", "required": [ "twentyFivePercentile", "fiftyPercentile", "seventyFivePercentile", "ninetyFivePercentile", "ninetyNinePercentile" ], "properties": { "fiftyPercentile": { "description": "50% of the invocations took less memory than this field's value.", "type": "number" }, "ninetyFivePercentile": { "description": "95% of the invocations took less memory than this field's value.", "type": "number" }, "ninetyNinePercentile": { "description": "99% of the invocations took less memory than this field's value.", "type": "number" }, "seventyFivePercentile": { "description": "75% of the invocations took less memory than this field's value.", "type": "number" }, "twentyFivePercentile": { "description": "25% of the invocations took less memory than this field's value.", "type": "number" } }, "x-akamai": { "file-path": "schemas/report-memory-usage-summary.yaml" } }, "onClientResponse": { "additionalProperties": false, "description": "Memory usage summary in percentiles for all invocations of `onClientResponse`.", "type": "object", "required": [ "twentyFivePercentile", "fiftyPercentile", "seventyFivePercentile", "ninetyFivePercentile", "ninetyNinePercentile" ], "properties": { "fiftyPercentile": { "description": "50% of the invocations took less memory than this field's value.", "type": "number" }, "ninetyFivePercentile": { "description": "95% of the invocations took less memory than this field's value.", "type": "number" }, "ninetyNinePercentile": { "description": "99% of the invocations took less memory than this field's value.", "type": "number" }, "seventyFivePercentile": { "description": "75% of the invocations took less memory than this field's value.", "type": "number" }, "twentyFivePercentile": { "description": "25% of the invocations took less memory than this field's value.", "type": "number" } }, "x-akamai": { "file-path": "schemas/report-memory-usage-summary.yaml" } }, "onOriginRequest": { "additionalProperties": false, "description": "Memory usage summary in percentiles for all invocations of `onOriginRequest`.", "type": "object", "required": [ "twentyFivePercentile", "fiftyPercentile", "seventyFivePercentile", "ninetyFivePercentile", "ninetyNinePercentile" ], "properties": { "fiftyPercentile": { "description": "50% of the invocations took less memory than this field's value.", "type": "number" }, "ninetyFivePercentile": { "description": "95% of the invocations took less memory than this field's value.", "type": "number" }, "ninetyNinePercentile": { "description": "99% of the invocations took less memory than this field's value.", "type": "number" }, "seventyFivePercentile": { "description": "75% of the invocations took less memory than this field's value.", "type": "number" }, "twentyFivePercentile": { "description": "25% of the invocations took less memory than this field's value.", "type": "number" } }, "x-akamai": { "file-path": "schemas/report-memory-usage-summary.yaml" } }, "onOriginResponse": { "additionalProperties": false, "description": "Memory usage summary in percentiles for all invocations of `onOriginResponse`.", "type": "object", "required": [ "twentyFivePercentile", "fiftyPercentile", "seventyFivePercentile", "ninetyFivePercentile", "ninetyNinePercentile" ], "properties": { "fiftyPercentile": { "description": "50% of the invocations took less memory than this field's value.", "type": "number" }, "ninetyFivePercentile": { "description": "95% of the invocations took less memory than this field's value.", "type": "number" }, "ninetyNinePercentile": { "description": "99% of the invocations took less memory than this field's value.", "type": "number" }, "seventyFivePercentile": { "description": "75% of the invocations took less memory than this field's value.", "type": "number" }, "twentyFivePercentile": { "description": "25% of the invocations took less memory than this field's value.", "type": "number" } }, "x-akamai": { "file-path": "schemas/report-memory-usage-summary.yaml" } }, "responseProvider": { "additionalProperties": false, "description": "Memory usage summary in percentiles for all invocations of `responseProvider`.", "type": "object", "required": [ "twentyFivePercentile", "fiftyPercentile", "seventyFivePercentile", "ninetyFivePercentile", "ninetyNinePercentile" ], "properties": { "fiftyPercentile": { "description": "50% of the invocations took less memory than this field's value.", "type": "number" }, "ninetyFivePercentile": { "description": "95% of the invocations took less memory than this field's value.", "type": "number" }, "ninetyNinePercentile": { "description": "99% of the invocations took less memory than this field's value.", "type": "number" }, "seventyFivePercentile": { "description": "75% of the invocations took less memory than this field's value.", "type": "number" }, "twentyFivePercentile": { "description": "25% of the invocations took less memory than this field's value.", "type": "number" } }, "x-akamai": { "file-path": "schemas/report-memory-usage-summary.yaml" } }, "totalMemoryUsage": { "additionalProperties": false, "description": "Memory usage summary in percentiles for all five event handlers.", "type": "object", "required": [ "twentyFivePercentile", "fiftyPercentile", "seventyFivePercentile", "ninetyFivePercentile", "ninetyNinePercentile" ], "properties": { "fiftyPercentile": { "description": "50% of the invocations took less memory than this field's value.", "type": "number" }, "ninetyFivePercentile": { "description": "95% of the invocations took less memory than this field's value.", "type": "number" }, "ninetyNinePercentile": { "description": "99% of the invocations took less memory than this field's value.", "type": "number" }, "seventyFivePercentile": { "description": "75% of the invocations took less memory than this field's value.", "type": "number" }, "twentyFivePercentile": { "description": "25% of the invocations took less memory than this field's value.", "type": "number" } }, "x-akamai": { "file-path": "schemas/report-memory-usage-summary.yaml" } } } } }, "x-akamai": { "file-path": "schemas/report-6.yaml" } }, { "description": "Specifies the total number of sub-requests.", "title": "Report 7", "type": "object", "items": { "additionalProperties": false, "description": "Subrequest data object.", "type": "object", "required": [ "subRequests" ], "properties": { "subRequests": { "description": "Total number of sub-requests.", "type": "object", "properties": { "total": { "description": "Total number of sub-requests.", "type": "integer" } } } } }, "x-akamai": { "file-path": "schemas/report-7.yaml" } } ] }, { "title": "List of reports", "type": "array", "items": { "oneOf": [ { "additionalProperties": false, "description": "Specifies execution and initialization times, grouped by event handler for each EdgeWorker.", "title": "Report 2", "type": "object", "required": [ "edgeWorkerId", "data" ], "properties": { "data": { "description": "Data points grouped by event handler and initialization mapping keys.", "type": "object", "additionalProperties": { "description": "Up to four event handler arrays and an init array for initialization data points.", "type": "array", "items": { "additionalProperties": false, "description": "Aggregated execution or initialization durations.", "type": "object", "required": [ "startDateTime", "edgeWorkerVersion", "invocations" ], "properties": { "edgeWorkerVersion": { "description": "The EdgeWorker version that was active during the execution of event handlers.", "type": "string" }, "execDuration": { "additionalProperties": false, "description": "Execution duration.", "type": "object", "required": [ "avg", "min", "max", "twentyFivePercentile", "fiftyPercentile", "seventyFivePercentile", "ninetyFivePercentile", "ninetyNinePercentile" ], "properties": { "avg": { "description": "Average clock time used to execute event handlers, in milliseconds.", "type": "number" }, "fiftyPercentile": { "description": "50% of the invocations took less execution time than this field's value, in milliseconds.", "type": "number" }, "max": { "description": "Maximum clock time used to execute event handlers, in milliseconds.", "type": "number" }, "min": { "description": "Minimum clock time used to execute event handlers, in milliseconds.", "type": "number" }, "ninetyFivePercentile": { "description": "95% of the invocations took less execution time than this field's value, in milliseconds.", "type": "number" }, "ninetyNinePercentile": { "description": "99% of the invocations took less execution time than this field's value, in milliseconds.", "type": "number" }, "seventyFivePercentile": { "description": "75% of the invocations took less execution time than this field's value, in milliseconds.", "type": "number" }, "twentyFivePercentile": { "description": "25% of the invocations took less execution time than this field's value, in milliseconds.", "type": "number" } }, "x-akamai": { "file-path": "schemas/report-exec-duration.yaml" } }, "initDuration": { "additionalProperties": false, "description": "Initialization duration.", "type": "object", "required": [ "avg", "min", "max", "twentyFivePercentile", "fiftyPercentile", "seventyFivePercentile", "ninetyFivePercentile", "ninetyNinePercentile" ], "properties": { "avg": { "description": "Average clock time used to initialize the event handlers, in milliseconds. The average is the sum of durations divided by the number of executions.", "type": "number" }, "fiftyPercentile": { "description": "50% of the invocations took less initialization time than this field's value, in milliseconds.", "type": "number" }, "max": { "description": "Maximum clock time used to initialize the event handlers, in milliseconds.", "type": "number" }, "min": { "description": "Minimum clock time used to initialize the event handlers, in milliseconds.", "type": "number" }, "ninetyFivePercentile": { "description": "95% of the invocations took less initialization time than this field's value, in milliseconds.", "type": "number" }, "ninetyNinePercentile": { "description": "99% of the invocations took less initialization time than this field's value, in milliseconds.", "type": "number" }, "seventyFivePercentile": { "description": "75% of the invocations took less initialization time than this field's value, in milliseconds.", "type": "number" }, "twentyFivePercentile": { "description": "25% of the invocations took less initialization time than this field's value, in milliseconds.", "type": "number" } }, "x-akamai": { "file-path": "schemas/report-init-duration.yaml" } }, "invocations": { "description": "Number of aggregated executions or initializations.", "type": "integer" }, "startDateTime": { "description": "Start date of the time period (ISO 8601).", "type": "string" } } } } }, "edgeWorkerId": { "description": "Unique identifier for an EdgeWorker.", "type": "integer" } }, "x-akamai": { "file-path": "schemas/report-2.yaml" } }, { "additionalProperties": false, "description": "Specifies execution success and error statuses, grouped by event handler for each EdgeWorker.", "title": "Report 3", "type": "object", "required": [ "edgeWorkerId", "data" ], "properties": { "data": { "description": "Data points grouped by event handler mapping keys.", "type": "object", "additionalProperties": { "description": "Up to four event handler arrays.", "type": "array", "items": { "additionalProperties": false, "description": "Aggregated execution status.", "type": "object", "required": [ "startDateTime", "edgeWorkerVersion", "status", "invocations" ], "properties": { "edgeWorkerVersion": { "description": "The EdgeWorker version that was active during the execution of event handlers.", "type": "string" }, "invocations": { "description": "Number of aggregated executions.", "type": "integer" }, "startDateTime": { "description": "Start date of the time period (ISO 8601).", "type": "string" }, "status": { "description": "Execution status.", "type": "string" } } } } }, "edgeWorkerId": { "description": "Unique identifier for an EdgeWorker.", "type": "integer" } }, "x-akamai": { "file-path": "schemas/report-3.yaml" } }, { "additionalProperties": false, "description": "Data array of EdgeWorker report ID 4.", "title": "Report 4", "type": "object", "required": [ "edgeWorkerId", "data" ], "properties": { "data": { "description": "Data points grouped by event handler mapping keys.", "type": "object", "additionalProperties": { "description": "Up to four event handler arrays.", "type": "array", "items": { "additionalProperties": false, "description": "Aggregated memory usage.", "type": "object", "required": [ "startDateTime", "edgeWorkerVersion", "memory", "invocations" ], "properties": { "edgeWorkerVersion": { "description": "The EdgeWorker version that was active during the execution of event handlers.", "type": "string" }, "invocations": { "description": "Number of aggregated executions.", "type": "integer" }, "memory": { "additionalProperties": false, "description": "Memory usage.", "type": "object", "required": [ "avg", "min", "max", "twentyFivePercentile", "fiftyPercentile", "seventyFivePercentile", "ninetyFivePercentile", "ninetyNinePercentile" ], "properties": { "avg": { "description": "Average memory used to execute event handlers.", "type": "number" }, "fiftyPercentile": { "description": "50% of the invocations took less memory than this field's value.", "type": "number" }, "max": { "description": "Maximum memory used to execute event handlers.", "type": "number" }, "min": { "description": "Minimum memory used to execute event handlers.", "type": "number" }, "ninetyFivePercentile": { "description": "95% of the invocations took less memory than this field's value.", "type": "number" }, "ninetyNinePercentile": { "description": "99% of the invocations took less memory than this field's value.", "type": "number" }, "seventyFivePercentile": { "description": "75% of the invocations took less memory than this field's value.", "type": "number" }, "twentyFivePercentile": { "description": "25% of the invocations took less memory than this field's value.", "type": "number" } }, "x-akamai": { "file-path": "schemas/report-memory-usage.yaml" } }, "startDateTime": { "description": "Start date of the time period (ISO 8601).", "type": "string" } } } } }, "edgeWorkerId": { "description": "Unique identifier for an EdgeWorker.", "type": "integer" } }, "x-akamai": { "file-path": "schemas/report-4.yaml" } }, { "additionalProperties": false, "description": "Specifies execution and initialization times with percentiles, grouped by event handler for each EdgeWorker ID.", "title": "Report 5", "type": "object", "required": [ "edgeWorkerId", "data", "summaryStatistics" ], "properties": { "data": { "description": "Data points grouped by event handler and initialization mapping keys.", "type": "object", "additionalProperties": { "description": "Up to four event handler arrays and an init array for initialization data points.", "type": "array", "items": { "additionalProperties": false, "description": "Aggregated execution or initialization durations.", "type": "object", "required": [ "startDateTime", "edgeWorkerVersion", "invocations" ], "properties": { "edgeWorkerVersion": { "description": "The EdgeWorker version active when the event handler executed.", "type": "string" }, "execDuration": { "additionalProperties": false, "description": "Execution duration.", "type": "object", "required": [ "avg", "min", "max", "twentyFivePercentile", "fiftyPercentile", "seventyFivePercentile", "ninetyFivePercentile", "ninetyNinePercentile" ], "properties": { "avg": { "description": "Average clock time used to execute event handlers, in milliseconds.", "type": "number" }, "fiftyPercentile": { "description": "50% of the invocations took less execution time than this field's value, in milliseconds.", "type": "number" }, "max": { "description": "Maximum clock time used to execute event handlers, in milliseconds.", "type": "number" }, "min": { "description": "Minimum clock time used to execute event handlers, in milliseconds.", "type": "number" }, "ninetyFivePercentile": { "description": "95% of the invocations took less execution time than this field's value, in milliseconds.", "type": "number" }, "ninetyNinePercentile": { "description": "99% of the invocations took less execution time than this field's value, in milliseconds.", "type": "number" }, "seventyFivePercentile": { "description": "75% of the invocations took less execution time than this field's value, in milliseconds.", "type": "number" }, "twentyFivePercentile": { "description": "25% of the invocations took less execution time than this field's value, in milliseconds.", "type": "number" } }, "x-akamai": { "file-path": "schemas/report-exec-duration.yaml" } }, "initDuration": { "additionalProperties": false, "description": "Initialization duration.", "type": "object", "required": [ "avg", "min", "max", "twentyFivePercentile", "fiftyPercentile", "seventyFivePercentile", "ninetyFivePercentile", "ninetyNinePercentile" ], "properties": { "avg": { "description": "Average clock time used to initialize the event handlers, in milliseconds. The average is the sum of durations divided by the number of executions.", "type": "number" }, "fiftyPercentile": { "description": "50% of the invocations took less initialization time than this field's value, in milliseconds.", "type": "number" }, "max": { "description": "Maximum clock time used to initialize the event handlers, in milliseconds.", "type": "number" }, "min": { "description": "Minimum clock time used to initialize the event handlers, in milliseconds.", "type": "number" }, "ninetyFivePercentile": { "description": "95% of the invocations took less initialization time than this field's value, in milliseconds.", "type": "number" }, "ninetyNinePercentile": { "description": "99% of the invocations took less initialization time than this field's value, in milliseconds.", "type": "number" }, "seventyFivePercentile": { "description": "75% of the invocations took less initialization time than this field's value, in milliseconds.", "type": "number" }, "twentyFivePercentile": { "description": "25% of the invocations took less initialization time than this field's value, in milliseconds.", "type": "number" } }, "x-akamai": { "file-path": "schemas/report-init-duration.yaml" } }, "invocations": { "description": "Number of aggregated executions or initializations.", "type": "integer" }, "startDateTime": { "description": "Start date of the time period (ISO 8601).", "type": "string" } } } } }, "edgeWorkerId": { "description": "Unique identifier for an EdgeWorker.", "type": "integer" }, "summaryStatistics": { "additionalProperties": false, "description": "Execution and initialization time summary in percentiles.", "type": "object", "required": [ "init", "onClientRequest", "onClientResponse", "onOriginRequest", "onOriginResponse", "responseProvider", "totalExecTime" ], "properties": { "init": { "additionalProperties": false, "description": "Initialization time summary in percentiles.", "type": "object", "required": [ "twentyFivePercentile", "fiftyPercentile", "seventyFivePercentile", "ninetyFivePercentile", "ninetyNinePercentile" ], "properties": { "fiftyPercentile": { "description": "50% of the invocations took less time than this field's value, in milliseconds.", "type": "number" }, "ninetyFivePercentile": { "description": "95% of the invocations took less time than this field's value, in milliseconds.", "type": "number" }, "ninetyNinePercentile": { "description": "99% of the invocations took less time than this field's value, in milliseconds.", "type": "number" }, "seventyFivePercentile": { "description": "75% of the invocations took less time than this field's value, in milliseconds.", "type": "number" }, "twentyFivePercentile": { "description": "25% of the invocations took less time than this field's value, in milliseconds.", "type": "number" } }, "x-akamai": { "file-path": "schemas/report-exec-and-init-summary.yaml" } }, "onClientRequest": { "additionalProperties": false, "description": "Execution time summary in percentiles for all invocations of `onClientRequest`.", "type": "object", "required": [ "twentyFivePercentile", "fiftyPercentile", "seventyFivePercentile", "ninetyFivePercentile", "ninetyNinePercentile" ], "properties": { "fiftyPercentile": { "description": "50% of the invocations took less time than this field's value, in milliseconds.", "type": "number" }, "ninetyFivePercentile": { "description": "95% of the invocations took less time than this field's value, in milliseconds.", "type": "number" }, "ninetyNinePercentile": { "description": "99% of the invocations took less time than this field's value, in milliseconds.", "type": "number" }, "seventyFivePercentile": { "description": "75% of the invocations took less time than this field's value, in milliseconds.", "type": "number" }, "twentyFivePercentile": { "description": "25% of the invocations took less time than this field's value, in milliseconds.", "type": "number" } }, "x-akamai": { "file-path": "schemas/report-exec-and-init-summary.yaml" } }, "onClientResponse": { "additionalProperties": false, "description": "Execution time summary in percentiles for all invocations of `onClientResponse`.", "type": "object", "required": [ "twentyFivePercentile", "fiftyPercentile", "seventyFivePercentile", "ninetyFivePercentile", "ninetyNinePercentile" ], "properties": { "fiftyPercentile": { "description": "50% of the invocations took less time than this field's value, in milliseconds.", "type": "number" }, "ninetyFivePercentile": { "description": "95% of the invocations took less time than this field's value, in milliseconds.", "type": "number" }, "ninetyNinePercentile": { "description": "99% of the invocations took less time than this field's value, in milliseconds.", "type": "number" }, "seventyFivePercentile": { "description": "75% of the invocations took less time than this field's value, in milliseconds.", "type": "number" }, "twentyFivePercentile": { "description": "25% of the invocations took less time than this field's value, in milliseconds.", "type": "number" } }, "x-akamai": { "file-path": "schemas/report-exec-and-init-summary.yaml" } }, "onOriginRequest": { "additionalProperties": false, "description": "Execution time summary in percentiles for all invocations of `onOriginRequest`.", "type": "object", "required": [ "twentyFivePercentile", "fiftyPercentile", "seventyFivePercentile", "ninetyFivePercentile", "ninetyNinePercentile" ], "properties": { "fiftyPercentile": { "description": "50% of the invocations took less time than this field's value, in milliseconds.", "type": "number" }, "ninetyFivePercentile": { "description": "95% of the invocations took less time than this field's value, in milliseconds.", "type": "number" }, "ninetyNinePercentile": { "description": "99% of the invocations took less time than this field's value, in milliseconds.", "type": "number" }, "seventyFivePercentile": { "description": "75% of the invocations took less time than this field's value, in milliseconds.", "type": "number" }, "twentyFivePercentile": { "description": "25% of the invocations took less time than this field's value, in milliseconds.", "type": "number" } }, "x-akamai": { "file-path": "schemas/report-exec-and-init-summary.yaml" } }, "onOriginResponse": { "additionalProperties": false, "description": "Execution time summary in percentiles for all invocations of `onOriginResponse`.", "type": "object", "required": [ "twentyFivePercentile", "fiftyPercentile", "seventyFivePercentile", "ninetyFivePercentile", "ninetyNinePercentile" ], "properties": { "fiftyPercentile": { "description": "50% of the invocations took less time than this field's value, in milliseconds.", "type": "number" }, "ninetyFivePercentile": { "description": "95% of the invocations took less time than this field's value, in milliseconds.", "type": "number" }, "ninetyNinePercentile": { "description": "99% of the invocations took less time than this field's value, in milliseconds.", "type": "number" }, "seventyFivePercentile": { "description": "75% of the invocations took less time than this field's value, in milliseconds.", "type": "number" }, "twentyFivePercentile": { "description": "25% of the invocations took less time than this field's value, in milliseconds.", "type": "number" } }, "x-akamai": { "file-path": "schemas/report-exec-and-init-summary.yaml" } }, "responseProvider": { "additionalProperties": false, "description": "Execution time summary in percentiles for all invocations of `responseProvider`.", "type": "object", "required": [ "twentyFivePercentile", "fiftyPercentile", "seventyFivePercentile", "ninetyFivePercentile", "ninetyNinePercentile" ], "properties": { "fiftyPercentile": { "description": "50% of the invocations took less time than this field's value, in milliseconds.", "type": "number" }, "ninetyFivePercentile": { "description": "95% of the invocations took less time than this field's value, in milliseconds.", "type": "number" }, "ninetyNinePercentile": { "description": "99% of the invocations took less time than this field's value, in milliseconds.", "type": "number" }, "seventyFivePercentile": { "description": "75% of the invocations took less time than this field's value, in milliseconds.", "type": "number" }, "twentyFivePercentile": { "description": "25% of the invocations took less time than this field's value, in milliseconds.", "type": "number" } }, "x-akamai": { "file-path": "schemas/report-exec-and-init-summary.yaml" } }, "totalExecTime": { "additionalProperties": false, "description": "Execution time summary in percentiles for all five event handlers.", "type": "object", "required": [ "twentyFivePercentile", "fiftyPercentile", "seventyFivePercentile", "ninetyFivePercentile", "ninetyNinePercentile" ], "properties": { "fiftyPercentile": { "description": "50% of the invocations took less time than this field's value, in milliseconds.", "type": "number" }, "ninetyFivePercentile": { "description": "95% of the invocations took less time than this field's value, in milliseconds.", "type": "number" }, "ninetyNinePercentile": { "description": "99% of the invocations took less time than this field's value, in milliseconds.", "type": "number" }, "seventyFivePercentile": { "description": "75% of the invocations took less time than this field's value, in milliseconds.", "type": "number" }, "twentyFivePercentile": { "description": "25% of the invocations took less time than this field's value, in milliseconds.", "type": "number" } }, "x-akamai": { "file-path": "schemas/report-exec-and-init-summary.yaml" } } } } }, "x-akamai": { "file-path": "schemas/report-5.yaml" } }, { "additionalProperties": false, "description": "Specifies memory usages with percentiles, grouped by event handler for each EdgeWorker ID.", "title": "Report 6", "type": "object", "required": [ "edgeWorkerId", "data", "summaryStatistics" ], "properties": { "data": { "description": "Data points grouped by event handler mapping keys.", "type": "object", "additionalProperties": { "description": "Up to four event handler arrays.", "type": "array", "items": { "additionalProperties": false, "description": "Aggregated memory usage.", "type": "object", "required": [ "startDateTime", "edgeWorkerVersion", "memory", "invocations" ], "properties": { "edgeWorkerVersion": { "description": "The EdgeWorker version that was active during the execution of event handlers.", "type": "string" }, "invocations": { "description": "Number of aggregated executions.", "type": "integer" }, "memory": { "additionalProperties": false, "description": "Memory usage (bytes).", "type": "object", "required": [ "avg", "min", "max", "twentyFivePercentile", "fiftyPercentile", "seventyFivePercentile", "ninetyFivePercentile", "ninetyNinePercentile" ], "properties": { "avg": { "description": "Average memory used to execute event handlers.", "type": "number" }, "fiftyPercentile": { "description": "50% of the invocations took less memory than this field's value.", "type": "number" }, "max": { "description": "Maximum memory used to execute event handlers.", "type": "number" }, "min": { "description": "Minimum memory used to execute event handlers.", "type": "number" }, "ninetyFivePercentile": { "description": "95% of the invocations took less memory than this field's value.", "type": "number" }, "ninetyNinePercentile": { "description": "99% of the invocations took less memory than this field's value.", "type": "number" }, "seventyFivePercentile": { "description": "75% of the invocations took less memory than this field's value.", "type": "number" }, "twentyFivePercentile": { "description": "25% of the invocations took less memory than this field's value.", "type": "number" } }, "x-akamai": { "file-path": "schemas/report-memory-usage.yaml" } }, "startDateTime": { "description": "Start date of the time period (ISO 8601).", "type": "string" } } } } }, "edgeWorkerId": { "description": "Unique identifier for an EdgeWorker.", "type": "integer" }, "summaryStatistics": { "additionalProperties": false, "description": "Memory usage summary in percentiles by event handler.", "type": "object", "required": [ "onClientRequest", "onClientResponse", "onOriginRequest", "onOriginResponse", "responseProvider", "totalMemoryUsage" ], "properties": { "onClientRequest": { "additionalProperties": false, "description": "Memory usage summary in percentiles for all invocations of `onClientRequest`.", "type": "object", "required": [ "twentyFivePercentile", "fiftyPercentile", "seventyFivePercentile", "ninetyFivePercentile", "ninetyNinePercentile" ], "properties": { "fiftyPercentile": { "description": "50% of the invocations took less memory than this field's value.", "type": "number" }, "ninetyFivePercentile": { "description": "95% of the invocations took less memory than this field's value.", "type": "number" }, "ninetyNinePercentile": { "description": "99% of the invocations took less memory than this field's value.", "type": "number" }, "seventyFivePercentile": { "description": "75% of the invocations took less memory than this field's value.", "type": "number" }, "twentyFivePercentile": { "description": "25% of the invocations took less memory than this field's value.", "type": "number" } }, "x-akamai": { "file-path": "schemas/report-memory-usage-summary.yaml" } }, "onClientResponse": { "additionalProperties": false, "description": "Memory usage summary in percentiles for all invocations of `onClientResponse`.", "type": "object", "required": [ "twentyFivePercentile", "fiftyPercentile", "seventyFivePercentile", "ninetyFivePercentile", "ninetyNinePercentile" ], "properties": { "fiftyPercentile": { "description": "50% of the invocations took less memory than this field's value.", "type": "number" }, "ninetyFivePercentile": { "description": "95% of the invocations took less memory than this field's value.", "type": "number" }, "ninetyNinePercentile": { "description": "99% of the invocations took less memory than this field's value.", "type": "number" }, "seventyFivePercentile": { "description": "75% of the invocations took less memory than this field's value.", "type": "number" }, "twentyFivePercentile": { "description": "25% of the invocations took less memory than this field's value.", "type": "number" } }, "x-akamai": { "file-path": "schemas/report-memory-usage-summary.yaml" } }, "onOriginRequest": { "additionalProperties": false, "description": "Memory usage summary in percentiles for all invocations of `onOriginRequest`.", "type": "object", "required": [ "twentyFivePercentile", "fiftyPercentile", "seventyFivePercentile", "ninetyFivePercentile", "ninetyNinePercentile" ], "properties": { "fiftyPercentile": { "description": "50% of the invocations took less memory than this field's value.", "type": "number" }, "ninetyFivePercentile": { "description": "95% of the invocations took less memory than this field's value.", "type": "number" }, "ninetyNinePercentile": { "description": "99% of the invocations took less memory than this field's value.", "type": "number" }, "seventyFivePercentile": { "description": "75% of the invocations took less memory than this field's value.", "type": "number" }, "twentyFivePercentile": { "description": "25% of the invocations took less memory than this field's value.", "type": "number" } }, "x-akamai": { "file-path": "schemas/report-memory-usage-summary.yaml" } }, "onOriginResponse": { "additionalProperties": false, "description": "Memory usage summary in percentiles for all invocations of `onOriginResponse`.", "type": "object", "required": [ "twentyFivePercentile", "fiftyPercentile", "seventyFivePercentile", "ninetyFivePercentile", "ninetyNinePercentile" ], "properties": { "fiftyPercentile": { "description": "50% of the invocations took less memory than this field's value.", "type": "number" }, "ninetyFivePercentile": { "description": "95% of the invocations took less memory than this field's value.", "type": "number" }, "ninetyNinePercentile": { "description": "99% of the invocations took less memory than this field's value.", "type": "number" }, "seventyFivePercentile": { "description": "75% of the invocations took less memory than this field's value.", "type": "number" }, "twentyFivePercentile": { "description": "25% of the invocations took less memory than this field's value.", "type": "number" } }, "x-akamai": { "file-path": "schemas/report-memory-usage-summary.yaml" } }, "responseProvider": { "additionalProperties": false, "description": "Memory usage summary in percentiles for all invocations of `responseProvider`.", "type": "object", "required": [ "twentyFivePercentile", "fiftyPercentile", "seventyFivePercentile", "ninetyFivePercentile", "ninetyNinePercentile" ], "properties": { "fiftyPercentile": { "description": "50% of the invocations took less memory than this field's value.", "type": "number" }, "ninetyFivePercentile": { "description": "95% of the invocations took less memory than this field's value.", "type": "number" }, "ninetyNinePercentile": { "description": "99% of the invocations took less memory than this field's value.", "type": "number" }, "seventyFivePercentile": { "description": "75% of the invocations took less memory than this field's value.", "type": "number" }, "twentyFivePercentile": { "description": "25% of the invocations took less memory than this field's value.", "type": "number" } }, "x-akamai": { "file-path": "schemas/report-memory-usage-summary.yaml" } }, "totalMemoryUsage": { "additionalProperties": false, "description": "Memory usage summary in percentiles for all five event handlers.", "type": "object", "required": [ "twentyFivePercentile", "fiftyPercentile", "seventyFivePercentile", "ninetyFivePercentile", "ninetyNinePercentile" ], "properties": { "fiftyPercentile": { "description": "50% of the invocations took less memory than this field's value.", "type": "number" }, "ninetyFivePercentile": { "description": "95% of the invocations took less memory than this field's value.", "type": "number" }, "ninetyNinePercentile": { "description": "99% of the invocations took less memory than this field's value.", "type": "number" }, "seventyFivePercentile": { "description": "75% of the invocations took less memory than this field's value.", "type": "number" }, "twentyFivePercentile": { "description": "25% of the invocations took less memory than this field's value.", "type": "number" } }, "x-akamai": { "file-path": "schemas/report-memory-usage-summary.yaml" } } } } }, "x-akamai": { "file-path": "schemas/report-6.yaml" } } ] } } ] }, "description": { "description": "Description of the EdgeWorker report.", "minLength": 1, "type": "string" }, "end": { "description": "ISO 8601 timestamp indicating the end time of the EdgeWorker report.", "format": "date-time", "type": "string" }, "name": { "description": "Name of the EdgeWorker report.", "minLength": 1, "type": "string" }, "reportId": { "description": "Unique identifier of the EdgeWorker report.", "minimum": 1, "type": "integer" }, "start": { "description": "ISO 8601 timestamp indicating the start time of the EdgeWorker report.", "format": "date-time", "type": "string" }, "unavailable": { "description": "Boolean stating if the report is available or not.", "type": "boolean" } }, "x-akamai": { "file-path": "schemas/report-get-200.yaml" } } } } } }, "parameters": [ { "description": "ISO 8601 timestamp indicating the start time of the EdgeWorker report.", "example": "{{start}}", "in": "query", "name": "start", "required": true, "schema": { "example": "2022-10-18T14:10:50Z", "format": "date-time", "type": "string" }, "x-akamai": { "file-path": "parameters/start-query.yaml" } }, { "description": "ISO 8601 timestamp indicating the end time of the EdgeWorker report. If not specified, the end time defaults to the current time.", "example": "{{end}}", "in": "query", "name": "end", "required": true, "schema": { "example": "2022-10-19T14:10:50Z", "format": "date-time", "type": "string" }, "x-akamai": { "file-path": "parameters/end-query.yaml" } }, { "description": "Filter by EdgeWorker ID such as `42` or more specific version such as `42-1.0`.", "example": "{{edgeWorker}}", "in": "query", "name": "edgeWorker", "required": true, "schema": { "example": 42, "type": "string" }, "x-akamai": { "file-path": "parameters/edgeWorker-query.yaml" } }, { "description": "__Enum__ Filter by the EdgeWorker status, either `success`, `genericError`, `unknownEdgeWorkerId`, `unimplementedEventHandler`, `runtimeError`, `executionError`, `timeoutError`, `resourceLimitHit`, `cpuTimeoutError`, `wallTimeoutError`, `initCpuTimeoutError`, or `initWallTimeoutError`.", "example": "{{status}}", "in": "query", "name": "status", "required": true, "schema": { "example": "runtimeError", "type": "string", "enum": [ "success", "genericError", "unknownEdgeWorkerId", "unimplementedEventHandler", "runtimeError", "executionError", "timeoutError", "resourceLimitHit", "cpuTimeoutError", "wallTimeoutError", "initCpuTimeoutError", "initWallTimeoutError" ] }, "x-akamai": { "file-path": "parameters/status-query.yaml" } }, { "description": "__Enum__ Filter EdgeWorkers by the event that triggers them, either `onClientRequest`, `onOriginRequest`, `onOriginResponse`, `onClientResponse`, or `responseProvider`.", "example": "{{eventHandler}}", "in": "query", "name": "eventHandler", "schema": { "example": "onClientRequest", "type": "string", "enum": [ "onClientRequest", "onOriginRequest", "onOriginResponse", "onClientResponse", "responseProvider" ] }, "x-akamai": { "file-path": "parameters/eventHandler-query.yaml" } }, { "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).", "example": "{{accountSwitchKey}}", "in": "query", "name": "accountSwitchKey", "required": false, "schema": { "example": "1-5C0YLB:1-8BYUX", "type": "string" } } ] }, "parameters": [ { "description": "Unique identifier of an EdgeWorker report.", "example": "{{reportId}}", "in": "path", "name": "reportId", "required": true, "schema": { "example": 7, "type": "integer" }, "x-akamai": { "file-path": "parameters/reportId-path.yaml" } } ] }, "/resource-tiers": { "get": { "description": "View the list of available resource tiers for a specific contract ID. The resource tier defines the resource consumption limits for an EdgeWorker ID.", "operationId": "get-resource-tiers", "summary": "Akamai List Resource Tiers", "tags": [ "Resource tiers" ], "externalDocs": { "description": "See documentation for this operation in Akamai's EdgeWorkers API", "url": "https://techdocs.akamai.com/edgeworkers/reference/get-resource-tiers" }, "responses": { "200": { "description": "Describes a list of resource tiers.", "content": { "application/json": { "example": { "resourceTiers": [ { "resourceTierId": 100, "resourceTierName": "Basic Compute", "edgeWorkerLimits": [ { "limitName": "Maximum CPU time during initialization", "limitUnit": "MILLISECOND", "limitValue": 30 }, { "limitName": "Maximum wall time during initialization", "limitUnit": "MILLISECOND", "limitValue": 100 }, { "limitName": "Maximum number of HTTP sub-requests allowed in parallel per EdgeWorker ID", "limitUnit": "COUNT", "limitValue": 0 }, { "limitName": "Maximum memory usage per event handler", "limitUnit": "BYTE", "limitValue": 1310720 }, { "limitName": "Maximum CPU time per event handler", "limitUnit": "MILLISECOND", "limitValue": 10 }, { "limitName": "Maximum wall time per event handler", "limitUnit": "MILLISECOND", "limitValue": 100 }, { "limitName": "Maximum number of HTTP sub-requests allowed from a parent request", "limitUnit": "COUNT", "limitValue": 0 }, { "limitName": "Maximum number of HTTP sub-requests allowed in parallel with the parent request", "limitUnit": "COUNT", "limitValue": 0 }, { "limitName": "Maximum wall time per HTTP sub-request", "limitUnit": "MILLISECOND", "limitValue": 0 }, { "limitName": "Maximum response size per HTTP sub-request", "limitUnit": "BYTE", "limitValue": 0 }, { "limitName": "Maximum memory usage for responseProvider", "limitUnit": "BYTE", "limitValue": 2097152 }, { "limitName": "Maximum CPU time for responseProvider", "limitUnit": "MILLISECOND", "limitValue": 100 }, { "limitName": "Maximum wall time for responseProvider", "limitUnit": "MILLISECOND", "limitValue": 4000 }, { "limitName": "Maximum number of HTTP sub-requests allowed for responseProvider", "limitUnit": "COUNT", "limitValue": 50 }, { "limitName": "Maximum number of HTTP sub-requests allowed in parallel for responseProvider", "limitUnit": "COUNT", "limitValue": 5 }, { "limitName": "Maximum wall time for HTTP sub-requests during the execution of the responseProvider event handler", "limitUnit": "MILLISECOND", "limitValue": 1000 }, { "limitName": "Maximum response size for HTTP sub-requests during the responseProvider event handler", "limitUnit": "BYTE", "limitValue": 1048576 } ] }, { "resourceTierId": 200, "resourceTierName": "Dynamic Compute", "edgeWorkerLimits": [ { "limitName": "Maximum CPU time during initialization", "limitUnit": "MILLISECOND", "limitValue": 30 }, { "limitName": "Maximum wall time during initialization", "limitUnit": "MILLISECOND", "limitValue": 100 }, { "limitName": "Maximum number of HTTP sub-requests allowed in parallel per EdgeWorker ID", "limitUnit": "COUNT", "limitValue": 0 }, { "limitName": "Maximum memory usage per event handler", "limitUnit": "BYTE", "limitValue": 1310720 }, { "limitName": "Maximum CPU time per event handler", "limitUnit": "MILLISECOND", "limitValue": 50 }, { "limitName": "Maximum wall time per event handler", "limitUnit": "MILLISECOND", "limitValue": 4000 }, { "limitName": "Maximum number of HTTP sub-requests allowed from a parent request", "limitUnit": "COUNT", "limitValue": 1 }, { "limitName": "Maximum number of HTTP sub-requests allowed in parallel with the parent request", "limitUnit": "COUNT", "limitValue": 1 }, { "limitName": "Maximum wall time per HTTP sub-request", "limitUnit": "MILLISECOND", "limitValue": 1000 }, { "limitName": "Maximum response size per HTTP sub-request", "limitUnit": "BYTE", "limitValue": 1048576 }, { "limitName": "Maximum memory usage for responseProvider", "limitUnit": "BYTE", "limitValue": 2097152 }, { "limitName": "Maximum CPU time for responseProvider", "limitUnit": "MILLISECOND", "limitValue": 100 }, { "limitName": "Maximum wall time for responseProvider", "limitUnit": "MILLISECOND", "limitValue": 4000 }, { "limitName": "Maximum number of HTTP sub-requests allowed for responseProvider", "limitUnit": "COUNT", "limitValue": 50 }, { "limitName": "Maximum number of HTTP sub-requests allowed in parallel for responseProvider", "limitUnit": "COUNT", "limitValue": 5 }, { "limitName": "Maximum wall time for HTTP sub-requests during the execution of the responseProvider event handler", "limitUnit": "MILLISECOND", "limitValue": 1000 }, { "limitName": "Maximum response size for HTTP sub-requests during the execution of the responseProvider event handler", "limitUnit": "BYTE", "limitValue": 1048576 } ] } ] }, "schema": { "additionalProperties": false, "type": "object", "required": [ "resourceTiers" ], "properties": { "resourceTiers": { "description": "List of resource tiers.", "minItems": 1, "type": "array", "items": { "additionalProperties": false, "type": "object", "required": [ "resourceTierId", "resourceTierName", "edgeWorkerLimits" ], "properties": { "edgeWorkerLimits": { "description": "List of EdgeWorker limits.", "minItems": 1, "type": "array", "items": { "additionalProperties": false, "description": "Provides details for an EdgeWorker limit.", "type": "object", "required": [ "limitName", "limitValue" ], "properties": { "limitName": { "description": "Name of the limit.", "minLength": 1, "readOnly": true, "type": "string" }, "limitUnit": { "description": "Unit of the limit, either `BYTE`, `MILLISECOND`, or `COUNT`.", "readOnly": true, "type": "string", "enum": [ "BYTE", "MILLISECOND", "COUNT" ] }, "limitValue": { "description": "Value of the limit.", "minimum": 0, "readOnly": true, "type": "integer" } }, "x-akamai": { "file-path": "schemas/ew-limit.yaml" } } }, "resourceTierId": { "description": "Unique identifier of the resource tier.", "minimum": 1, "type": "integer" }, "resourceTierName": { "description": "Name of the resource tier.", "minLength": 1, "type": "string" } }, "x-akamai": { "file-path": "schemas/resource-tier-get-200.yaml" } } } }, "x-akamai": { "file-path": "schemas/resource-tiers-get-200.yaml" } } } } } }, "parameters": [ { "description": "Unique identifier of a contract.", "example": "{{contractId}}", "in": "query", "name": "contractId", "required": true, "schema": { "example": "1-599K", "type": "string" }, "x-akamai": { "file-path": "parameters/contractId-query.yaml" } }, { "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).", "example": "{{accountSwitchKey}}", "in": "query", "name": "accountSwitchKey", "required": false, "schema": { "example": "1-5C0YLB:1-8BYUX", "type": "string" } } ] } }, "/secure-token": { "post": { "description": "Generate a JWT authentication token to [enable enhanced debug headers](https://techdocs.akamai.com/edgeworkers/docs/enable-enhanced-debug-headers) for EdgeWorkers.", "operationId": "post-secure-token", "summary": "Akamai Create a Secure Token", "tags": [ "Secure tokens" ], "externalDocs": { "description": "See documentation for this operation in Akamai's EdgeWorkers API", "url": "https://techdocs.akamai.com/edgeworkers/reference/post-secure-token" }, "requestBody": { "required": true, "content": { "application/json": { "example": { "expiry": 30, "hostname": "www.example.com", "propertyId": "123456789", "hostnames": [ "www.hostname1.com", "www.hostname2.com" ] }, "schema": { "additionalProperties": false, "minProperties": 1, "type": "object", "properties": { "expiry": { "default": 480, "description": "Number of minutes before the authentication token expires, from 1 to 720 minutes, or 12 hours. The default is `480` for 8 hours.", "example": "{{expiry}}", "maximum": 720, "minimum": 1, "type": "integer" }, "hostname": { "description": "__Deprecated__ Use the `hostnames` parameter instead. Hostname for a property. To create an authentication token, provide either the `hostname`, or the `propertyId`, but not both.", "example": "{{hostname}}", "minLength": 1, "type": "string", "x-akamai": { "status": "DEPRECATED" } }, "hostnames": { "description": "List of hostnames for a property. To create an authentication token, provide either the list of `hostnames`, or the `propertyId`, but not both. Specify `/*` to generate an authentication token valid for all hosts.", "minItems": 1, "type": "array", "items": { "type": "string" } }, "propertyId": { "description": "Unique identifier for a property. To create an authentication token, provide either the `propertyId` or the `hostname`, but not both.", "example": "{{propertyId}}", "minLength": 1, "type": "string" } }, "x-akamai": { "file-path": "schemas/secure-token-post.yaml" } } } } }, "responses": { "201": { "description": "A generated JWT authentication token, for use with enhanced debug headers for EdgeWorkers. See [Enhanced debug headers](https://techdocs.akamai.com/edgeworkers/docs/enhanced-debug-header-details).", "content": { "application/json": { "example": { "akamaiEwTrace": "eyJ0eXAiOiJKV1Qi ... iu1XOS9eJOl-54Yw" }, "schema": { "additionalProperties": false, "type": "object", "required": [ "akamaiEwTrace" ], "properties": { "akamaiEwTrace": { "description": "The JWT authentication token, for use with enhanced debug headers for EdgeWorkers.", "type": "string" } }, "x-akamai": { "file-path": "schemas/secure-token-200.yaml" } } } } }, "400": { "description": "A specified hostname does not exist in the property.", "content": { "application/problem+json": { "example": { "detail": "Host name provided does not exist in the property ", "errorCode": "EW4807", "instance": "f6d70100-9214-45d8-8a22-3974bb40db1f", "status": 400, "title": "Bad Request", "type": "/edgeworkers/error-types/invalid-host-name" }, "schema": { "additionalProperties": false, "description": "Error messaging.", "type": "object", "properties": { "detail": { "description": "A description of the error.", "type": "string" }, "errorCode": { "description": "Internal error code used to assist with troubleshooting by Akamai employees.", "type": "string" }, "instance": { "description": "Reference to unique instance of the error.", "type": "string" }, "status": { "description": "The HTTP code associated with the error.", "type": "integer" }, "title": { "description": "Text representation of the HTTP error code.", "type": "string" }, "type": { "description": "Reference to additional documentation.", "type": "string" } }, "x-akamai": { "file-path": "schemas/error.yaml" } } } } } }, "parameters": [ { "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).", "example": "{{accountSwitchKey}}", "in": "query", "name": "accountSwitchKey", "required": false, "schema": { "example": "1-5C0YLB:1-8BYUX", "type": "string" } } ] } }, "/secure-token/{propertyId}": { "get": { "description": "__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.", "operationId": "get-secure-token", "summary": "Akamai Get a Secure Token", "tags": [ "Secure tokens" ], "externalDocs": { "description": "See documentation for this operation in Akamai's EdgeWorkers API", "url": "https://techdocs.akamai.com/edgeworkers/reference/get-secure-token" }, "responses": { "200": { "description": "A generated authentication token, for use with enhanced debug headers for EdgeWorkers. See [Enhanced debug headers](https://techdocs.akamai.com/edgeworkers/docs/enhanced-debug-header-details).", "content": { "application/json": { "example": { "akamaiEwTrace": "eyJ0eXAiOiJKV1Qi ... iu1XOS9eJOl-54Yw" }, "schema": { "additionalProperties": false, "type": "object", "required": [ "akamaiEwTrace" ], "properties": { "akamaiEwTrace": { "description": "The JWT authentication token, for use with enhanced debug headers for EdgeWorkers.", "type": "string" } }, "x-akamai": { "file-path": "schemas/secure-token-200.yaml" } } } } } }, "x-akamai": { "status": "DEPRECATED" }, "parameters": [ { "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`.", "example": "{{acl}}", "in": "query", "name": "acl", "schema": { "default": "/*", "example": "/*", "type": "string" }, "x-akamai": { "file-path": "parameters/acl-query.yaml" } }, { "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`.", "example": "{{url}}", "in": "query", "name": "url", "schema": { "example": "/path/to/page.html", "format": "uri", "type": "string" }, "x-akamai": { "file-path": "parameters/url-query.yaml" } }, { "description": "Number of minutes before the authentication token expires, from a minute to an hour. The default is 15.", "example": "{{expiry}}", "in": "query", "name": "expiry", "schema": { "default": 15, "example": 5, "maximum": 60, "minimum": 1, "type": "integer" }, "x-akamai": { "file-path": "parameters/expiry-query.yaml" } }, { "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.", "example": "{{network}}", "in": "query", "name": "network", "schema": { "example": "STAGING", "type": "string", "enum": [ "STAGING", "PRODUCTION" ] }, "x-akamai": { "file-path": "parameters/network-query.yaml" } }, { "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).", "example": "{{accountSwitchKey}}", "in": "query", "name": "accountSwitchKey", "required": false, "schema": { "example": "1-5C0YLB:1-8BYUX", "type": "string" } } ] }, "parameters": [ { "description": "Unique identifier for a property.", "example": "{{propertyId}}", "in": "path", "name": "propertyId", "required": true, "schema": { "example": "123456789", "type": "string" }, "x-akamai": { "file-path": "parameters/propertyId-path.yaml" } } ] }, "/validations": { "post": { "description": "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`.", "operationId": "post-validations", "summary": "Akamai Validate an EdgeWorkers Code Bundle", "tags": [ "Validations" ], "externalDocs": { "description": "See documentation for this operation in Akamai's EdgeWorkers API", "url": "https://techdocs.akamai.com/edgeworkers/reference/post-validations" }, "requestBody": { "required": true, "content": { "application/gzip": { "schema": { "format": "binary", "type": "string" } } } }, "responses": { "200": { "description": "Provides details for an EdgeWorkers code bundle validation.", "content": { "application/json": { "example": { "errors": [ { "message": "static validation failed : main.js::9:16 SyntaxError: Unexpected identifier.", "type": "STATIC_VALIDATION_FAILED" }, { "message": "manifest file is invalid", "type": "INVALID_MANIFEST" } ], "warnings": [ { "message": "The EdgeKV access token is still valid but will expire soon.", "type": "ACCESS_TOKEN_EXPIRING_SOON" } ] }, "schema": { "additionalProperties": false, "type": "object", "required": [ "errors", "warnings" ], "properties": { "errors": { "description": "List of validation errors.", "minItems": 1, "type": "array", "items": { "additionalProperties": false, "description": "Provides details for an EdgeWorker code bundle validation error.", "type": "object", "required": [ "type", "message" ], "properties": { "message": { "description": "Message containing more details about the validation error.", "minLength": 1, "readOnly": true, "type": "string" }, "type": { "description": "The type of the validation error. See [Validation error types](https://techdocs.akamai.com/edgeworkers/reference/validation-types).", "readOnly": true, "type": "string", "enum": [ "ACCESS_TOKEN_EXPIRED", "ACCESS_TOKEN_INVALID", "ACCESS_TOKEN_MISSING", "EDGEKV_FILE_MISSING", "EDGEKV_TOKENS_FILE_MISSING", "EMPTY_TARBALL", "INVALID_EDGEKV_IMPORTS", "INVALID_GZIP_FORMAT", "INVALID_MANIFEST", "INVALID_TAR_ARCHIVE", "MAX_COMPRESSED_SIZE_EXCEEDED", "MAX_UNCOMPRESSED_SIZE_EXCEEDED", "MISSING_MANDATORY_FILES", "STATIC_VALIDATION_FAILED", "DEPENDENCY_NOT_FOUND", "MISSING_MEGABUNDLE_JSON_FILE", "MISSING_DEPENDENCIES_DIRECTORY", "INVALID_MEGABUNDLE_JSON_FILE" ] } }, "x-akamai": { "file-path": "schemas/validation-error.yaml" } } }, "warnings": { "description": "List of validation warnings.", "minItems": 1, "type": "array", "items": { "additionalProperties": false, "description": "Provides details for an EdgeWorker code bundle validation warning.", "type": "object", "required": [ "type", "message" ], "properties": { "message": { "description": "Message containing more details about the validation warning.", "minLength": 1, "readOnly": true, "type": "string" }, "type": { "description": "The type of the validation warning. See [Validation warning types](https://techdocs.akamai.com/edgeworkers/reference/validation-types).", "readOnly": true, "type": "string", "enum": [ "ACCESS_TOKEN_EXPIRING_SOON" ] } }, "x-akamai": { "file-path": "schemas/validation-warning.yaml" } } } }, "x-akamai": { "file-path": "schemas/validations-post-200.yaml" } } } } } }, "parameters": [ { "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).", "example": "{{accountSwitchKey}}", "in": "query", "name": "accountSwitchKey", "required": false, "schema": { "example": "1-5C0YLB:1-8BYUX", "type": "string" } } ] } } }, "x-readme": { "samples-languages": [ "curl", "python", "node" ] }, "servers": [ { "url": "https://{hostname}/edgeworkers/v1" } ] }