Akamai: DataStream 2 API
Monitors activity on the Akamai platform and sends live log data to a destination of your choice.
Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.
Overview
Monitors activity on the Akamai platform and sends live log data to a destination of your choice.
Endpoints 14
Groups
- GETList groups
/log/groups?contractId={{contractId}}Returns access groups with contracts on your account. You can later use the groupId and contractId values to create and view streams or list properties by…
Properties
- GETList properties by group
/log/groups/:groupId/propertiesReturns properties that are active on the production and staging network and available within a specific group. Run this operation to get and store the…
Data sets
- GETList data set fields
/log/datasets-fields?productId={{productId}}Returns the list of available data set fields you can choose to monitor in your logs in a stream configuration. Set the productId query parameter to get data…
Streams
- GETList streams
/log/streams?groupId={{groupId}}&propertyName={{propertyName}}Returns the latest versions of the stream configurations for all groups within your account. You can use the groupId parameter to view the latest versions of… - POSTCreate a stream
/log/streams?activate={{activate}}Creates a stream configuration. Within a stream configuration, you can select properties to monitor in the stream, data set fields to collect in logs, and a… - GETView upload metrics
/log/streams/metrics?start={{start}}&end={{end}}&streamId={{streamId}}&groupId={{groupId}}&aggregationInterval={{aggregationInterval}}&includeDetails={{includeDetails}}Returns aggregated metrics for log file uploads, including success or failure upload counts, upload latency, and the volume of data uploaded in the stream.… - GETGet a stream
/log/streams/:streamId?version={{version}}Returns information about any version of a stream, including details about the monitored properties, logged data set fields, and log delivery destination. If… - PUTEdit a stream
/log/streams/:streamId?activate={{activate}}Updates the latest version of a stream. Running this operation creates a version of the stream that replaces the existing one. Note that only active streams… - DELETEDelete a stream
/log/streams/:streamIdDeletes a deactivated stream. Deleting a stream means that you can't activate this stream again, and that you stop receiving logs for the properties that this… - PATCHPatch a stream
/log/streams/:streamId?activate={{activate}}Updates selected details of an existing stream. Running this operation using JSON Patch syntax creates a stream version that replaces the current one.…
Activations
- POSTActivate a stream
/log/streams/:streamId/activateActivates the latest version of a stream. Activating a stream takes approximately an hour. Once a stream is active, and the DataStream behavior is enabled in… - GETView activation history
/log/streams/:streamId/activation-historyReturns the details of activation status changes for all versions of a given stream. - POSTDeactivate a stream
/log/streams/:streamId/deactivateDeactivates the latest version of a stream. Deactivating a stream means that you stop receiving logs for the properties that this stream monitors and changes…
History
- GETView history
/log/streams/:streamId/history?startVersion={{startVersion}}&endVersion={{endVersion}}Returns details about all versions of a given stream. It helps you track changes between the versions of the stream, including monitored properties, logged…
API details
- Base URL
https://{hostname}/datastream-config-api/v2- Authentication
- None declared in the description
- Operations
- 14 operations on 10 pathsGET 8POST 3PUT 1PATCH 1DELETE 1
- Main resources
- Streams 7Activations 3Data sets 1Groups 1History 1Properties 1
- Response formats
application/json- Description format
- OpenAPI 3.0.0, API version
v2 - Links
- Documentation · OpenAPI document
- Listed from
- Akamai's published OpenAPI description (akamai/akamai-apis) (Apache-2.0)
How to test the Akamai: DataStream 2 API in Swastik Codes
- Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
- Fork it into your workspaceChoose a workspace. You get your own copy of the Akamai: DataStream 2 API collection, without the publisher's secrets.
- Add your credentialsOpen the collection's variables or an environment and enter your API key or token, if the API needs one.
- Send a requestPick an endpoint, for example “List groups” (GET /log/groups?contractId={{contractId}}), and press Send. Check the response, add tests and run the whole collection with the runner.
Frequently asked questions
What is the Akamai: DataStream 2 API?
Monitors activity on the Akamai platform and sends live log data to a destination of your choice. It is listed under Developer tools and has 14 endpoints.
Who publishes the Akamai: DataStream 2 API?
It is listed from Akamai's public API description (an OpenAPI document), not published by Akamai on Swastik Codes. Anyone who controls akamai.com can claim the profile by adding a DNS TXT record.
What is the base URL of the Akamai: DataStream 2 API?
Requests go to https://{hostname}/datastream-config-api/v2. Endpoint paths are added to this base URL.
How do I authenticate with the Akamai: DataStream 2 API?
Its OpenAPI description does not declare an authentication scheme. Some endpoints may be open; check the provider's documentation before relying on that.
How many endpoints does the Akamai: DataStream 2 API have?
14 operations on 10 paths (8 GET, 3 POST, 1 PUT, 1 PATCH, 1 DELETE). The largest groups are Streams, Activations, Data sets, Groups.
Is forking the Akamai: DataStream 2 API free?
Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.