Support for DataStream API v2 ends on December 16, 2026. After this date, API v2 endpoints will be decommissioned and start returning a 410 error.
Follow this guide and migrate to the API v3 to access new features and avoid service disruptions. To avoid data loss, make sure to update and verify scripts, pipelines, Terraform configurations, and integrations you use before this deadline.
Why API v3?
The DataStream API v3 is the only actively supported and continuously updated version of the API. Migrate to the v3 to leverage new features including:
- New log types for Edge DNS, EdgeWorkers, Global Traffic Management (GTM), and security event logs (SIEM)
- Creating DataStream-managed streams without Property Manager configuration
- Low-latency or high-completeness latency delivery profiles
- WebSocket logs
What's changing?
The most important changes in the API v3 include changing the API version and introducing log types into endpoint URL paths.
In each path, v2 becomes v3, and each new log type (delivery for CDN, EdgeDNS, EdgeWorkers, GTM, and SIEM security logs) get a new parameter after log/:
cdnfor delivery (CDN) logsednsfor EdgeDNS logsewfor EdgeWorkers logsappsecfor security events (SIEM) logs
API v2 endpoint example:
https://{hostname}/datastream-config-api/v2/log/streamsAPI v3 endpoint example:
https://{hostname}/datastream-config-api/v3/log/cdn/streamsSince existing delivery (CDN) streams use the cdn log type, most migrations require changing v2 to v3 and adding cdn to the endpoint URL path to complete the migration.
Operations
Here's a list of changing endpoints for delivery (CDN) streams:
| Operation | v2 | v3 |
|---|---|---|
| Create a delivery (CDN) stream | POST /datastream-config-api/v2/log/streams | POST /datastream-config-api/v3/log/cdn/streams |
| List streams | GET /datastream-config-api/v2/log/streams | GET /datastream-config-api/v3/log/cdn/streams |
| Get a stream | GET /datastream-config-api/v2/log/streams/{id} | GET /datastream-config-api/v3/log/cdn/streams/{id} |
| Edit a delivery (CDN) stream | PUT /datastream-config-api/v2/log/streams/{id} | PUT /datastream-config-api/v3/log/cdn/streams/{id} |
| Delete a stream | DELETE /datastream-config-api/v2/log/streams/{id} | DELETE /datastream-config-api/v3/log/cdn/streams/{id} |
| Activate a stream | POST /datastream-config-api/v2/log/streams/{id}/activate | POST /datastream-config-api/v3/log/cdn/streams/{id}/activate |
| List CDN properties by group | GET /datastream-config-api/v2/log/groups/{id}/properties | GET /datastream-config-api/v3/log/cdn/groups/{id}/properties |
| List data set fields | GET /datastream-config-api/v2/log/datasets-fields | GET /datastream-config-api/v3/log/cdn/datasets-fields |
How to migrate
Follow the steps below to migrate your delivery (CDN) stream from v2 API to v3 API:
- Check your source code, Terraform configurations, pipelines, and API collections for v2 API paths without the log type.
Examples:log/streams,/log/groups,/log/datasets-fields - In the endpoint URL paths, change the version from
v2tov3, and add new log types, such ascdnfor delivery (CDN) streams. - Check the data set fields in the stream and the destination where you want to send logs. Run GET on
/log/cdn/datasets-fieldsif needed.
Note: The TrafficPeak and Dynatrace destinations accept only the JSON log format. - Test your configuration in the staging environment.
- Create a delivery (CDN) stream with v3 settings, and confirm that your destination receives the payload.
- If needed, upgrade the Terraform provider and review your Terraform plan before applying the changes.
- If needed, handle Rate limiting. When migrating streams in bulk, a 429 response lists possible errors. Fix them and retry.
FAQ
| Question | Answer |
|---|---|
| When will the DataStream API v2 stop working? | After December 16, 2026, the API v2 endpoints will stop serving traffic and start returning 410 error codes. |
| What happens if I don't migrate in time? | Calling v2, scripts, pipelines, Terraform, integrations will fail once the endpoints start returning 410. There's no grace period after the date. We recommend migrating and verifying the new stream before it happens. |
| Do my existing streams stop delivering logs? | No. The decommission affects the v2 API, not your streams. Your streams keep running. What you must update is any code or automation that refers to v2 endpoints. |
| Do I have to recreate my streams? | No. For most users, this is an endpoint change. Point your existing automation to the v3 paths and add the log type cdn for delivery streams. |
| What's the changes I need to make? | Change the API version from v2 to v3 and add the log type to the path (e.g., POST /datastream-config-api/v2/log/streams becomes POST /datastream-config-api/v3/log/cdn/streams). For standard delivery streams, use cdn. |
| What do I gain by moving to v3? | Four more log types (Edge DNS, EdgeWorkers, GTM, and Security logs/SIEM), DataStream-managed streams, latency profiles, WebSocket logs, allowed-IP delivery. See Supported features in the v3 user guide. |
| I use the Akamai Terraform provider. What changes? | Upgrade to a v3-compatible provider version and update your resource definitions. Run the Terraform plan and review the diff before applying your changes. |
| Are there any changes in billing? | No. Billing for DataStream doesn't change after migrating for v3. |
| Where do I get help? | Get in touch with your Akamai account team or create a post in the DataStream 2.0 PLEs. |
