--- updatedAt: 2026-09-01T12:57:17.000Z agentTools: siteIndex: https://techdocs.akamai.com/llms.txt projectIndex: https://techdocs.akamai.com/edgeworkers/llms.txt --- # List environments __Beta__ View the environments where an existing EdgeWorker is attached. You can limit the results to environments where a version is active on the production or staging network. The dev-test environment is not currently ready for use and its name may change. For more information, see [Delivery Manager Beta](doc:delivery-manager-beta) in this guide. # OpenAPI definition ```json { "externalDocs": { "description": "See documentation for Akamai's EdgeWorkers API", "url": "https://techdocs.akamai.com/edgeworkers/reference" }, "info": { "license": { "name": "Apache 2.0", "url": "https://www.apache.org/licenses/LICENSE-2.0.html" }, "title": "EdgeWorker IDs", "version": "v1" }, "openapi": "3.0.0", "paths": { "/ids/{edgeWorkerId}/environments": { "get": { "description": "__Beta__ View the environments where an existing EdgeWorker is attached. You can limit the results to environments where a version is active on the production or staging network. The dev-test environment is not currently ready for use and its name may change. For more information, see [Delivery Manager Beta](https://techdocs.akamai.com/edgeworkers/docs/delivery-manager-beta) in this guide.", "externalDocs": { "description": "See documentation for this operation in Akamai's EdgeWorkers API", "url": "https://techdocs.akamai.com/edgeworkers/reference/get-environments" }, "operationId": "get-environments", "parameters": [ { "description": "When set to `true`, limits results to environments where any EdgeWorker version is active on production or staging. The dev-test environment is not currently ready for use and its name may change.", "in": "query", "name": "activeOnly", "schema": { "default": false, "example": true, "type": "boolean" }, "x-akamai": { "file-path": "parameters/active-only-environments-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).", "in": "query", "name": "accountSwitchKey", "required": false, "schema": { "example": "1-5C0YLB:1-8BYUX", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "example": { "environments": [ { "environmentDisplayName": "my-prod-env", "environmentName": "my-prod-env-1223434", "latestVersion": 11, "profile": { "useCase": "PRODUCTION" }, "stagingVersion": 10, "stagingVersionLink": "/delivery-manager/v1/workspaces/my-site-ws-5678/environments/my-prod-env-1223434/versions/10/generated-rule-tree", "workspaceDisplayName": "my-site-ws", "workspaceName": "my-site-ws-5678" }, { "environmentDisplayName": "my-prod-env", "environmentName": "my-prod-env-9999", "latestVersion": 5, "productionVersion": 3, "productionVersionLink": "/delivery-manager/v1/workspaces/another-ws-1111/environments/my-prod-env-9999/versions/3/generated-rule-tree", "profile": { "useCase": "PRODUCTION" }, "stagingVersion": 4, "stagingVersionLink": "/delivery-manager/v1/workspaces/another-ws-1111/environments/my-prod-env-9999/versions/4/generated-rule-tree", "workspaceDisplayName": "another-ws", "workspaceName": "another-ws-1111" }, { "environmentDisplayName": "my-loadtest-env", "environmentName": "my-loadtest-env-42", "latestVersion": 7, "productionVersion": 6, "productionVersionLink": "/delivery-manager/v1/workspaces/my-site-ws-5678/environments/my-loadtest-env-42/versions/6/generated-rule-tree", "profile": { "useCase": "TESTING" }, "workspaceDisplayName": "my-site-ws", "workspaceName": "my-site-ws-5678" }, { "devVersion": 2, "devVersionLink": "/delivery-manager/v1/workspaces/my-site-ws-5678/environments/my-dev-env-777/versions/2/generated-rule-tree", "environmentDisplayName": "my-dev-env", "environmentName": "my-dev-env-777", "latestVersion": 3, "profile": { "useCase": "DEVELOPMENT" }, "profileType": "Dev-test", "workspaceDisplayName": "my-site-ws", "workspaceName": "my-site-ws-5678" }, { "devVersion": 8, "devVersionLink": "/delivery-manager/v1/workspaces/another-ws-1111/environments/my-dev-env-8888/versions/8/generated-rule-tree", "environmentDisplayName": "my-dev-env", "environmentName": "my-dev-env-8888", "latestVersion": 8, "profile": { "useCase": "DEVELOPMENT" }, "workspaceDisplayName": "another-ws", "workspaceName": "another-ws-1111" } ], "limitedAccessToEnvironments": false }, "schema": { "additionalProperties": false, "description": "This object collects data on delivery workspace environments that use an EdgeWorker. See the [Delivery Manager API](https://techdocs.akamai.com/delivery-mgr/reference/api) for more details on managing Akamai delivery configurations.", "properties": { "environments": { "description": "List of environments.", "items": { "additionalProperties": false, "properties": { "devVersion": { "description": "Placeholder for the development version. This property is not currently ready for use. The property name may change.", "minimum": 1, "nullable": true, "type": "integer" }, "devVersionLink": { "description": "Placeholder for the link to the development version. This property is not currently ready for use. The property name may change.", "nullable": true, "type": "string" }, "environmentDisplayName": { "description": "Name of the environment visible in the Control Center application.", "minLength": 1, "type": "string" }, "environmentName": { "description": "Name of the environment, unique within a workspace.", "minLength": 1, "type": "string" }, "latestVersion": { "description": "Specifies the most recent version created in the environment.", "minimum": 1, "nullable": true, "type": "integer" }, "productionVersion": { "description": "The environment version that’s currently active on the production network.", "minimum": 1, "nullable": true, "type": "integer" }, "productionVersionLink": { "description": "The link to the production environment version.", "nullable": true, "type": "string" }, "profile": { "additionalProperties": false, "description": "A profile defines a blueprint for environments, establishing core settings such as persistence, routing, network targets, and history retention.", "properties": { "useCase": { "description": "The profile's use case, which determines the default settings for environments created with this profile. The `PRODUCTION` profile serves live traffic and represents a permanent environment with access to staging and production networks. You can only have one environment with the `PRODUCTION` profile in a workspace. The `DEVELOPMENT` profile works for development and testing purposes. You can have several environments with the `DEVELOPMENT` profile active in a workspace at a time. For the ephemeral `DEVELOPMENT` profile, you can set an expiry time to automatically deactivate short-lived, non-production environments. The `TESTING` profile behaves like `PRODUCTION` — it has access to staging and production networks — except you can have several environments with the `TESTING` profile in a workspace at a time.", "enum": [ "PRODUCTION", "DEVELOPMENT", "TESTING" ], "type": "string" } }, "required": [ "useCase" ], "type": "object" }, "stagingVersion": { "description": "The environment version on staging.", "minimum": 1, "nullable": true, "type": "integer" }, "stagingVersionLink": { "description": "The environment version that’s currently active on the staging network.", "nullable": true, "type": "string" }, "workspaceDisplayName": { "description": "Name of the workspace visible in the Control Center application.", "minLength": 1, "type": "string" }, "workspaceName": { "description": "Name of the workspace that unifies all resources for your application or service.", "minLength": 1, "type": "string" } }, "required": [ "environmentName", "workspaceName" ], "type": "object" }, "minItems": 0, "type": "array" }, "limitedAccessToEnvironments": { "description": "Indicates whether you have limited access to environments. Returns only environments granted by your [IAM group permissions](https://techdocs.akamai.com/delivery-mgr/docs/concepts-and-terms#groups).", "type": "boolean" } }, "required": [ "environments" ], "type": "object", "x-akamai": { "file-path": "schemas/environments-get-200.yaml" } } } }, "description": "The response lists environments whose rule sets have attached `edgeWorker` behaviors." } }, "summary": "List environments", "tags": [ "Environments" ], "x-akamai": { "status": "BETA" } }, "parameters": [ { "description": "Unique identifier for an EdgeWorker.", "in": "path", "name": "edgeWorkerId", "required": true, "schema": { "example": 42, "minimum": 1, "type": "integer" }, "x-akamai": { "file-path": "parameters/edge-worker-id-path.yaml" } } ] } }, "servers": [ { "url": "https://{hostname}/edgeworkers/v1" } ], "tags": [ { "description": "Get information about the environments using EdgeWorkers.", "name": "Environments" } ], "x-akamai": { "auth-type": "EDGE_GRID", "file-path": "ids.yaml" }, "x-readme": { "explorer-enabled": false, "samples-languages": [ "curl", "python", "node" ] } } ``` # Sibling pages * [Get EdgeWorker behavior locations for an environment version](https://techdocs.akamai.com/edgeworkers/reference/get-environment-edgeworker-locations.md)