Create a delivery stream

post

https://{hostname}/datastream-config-api/v3/log/cdn/streams

Creates a stream configuration for delivery products. You can choose delivery properties to monitor in the stream, data set fields to collect in logs, and a destination to send these log files to. Get the streamId value from the response to Get a stream. Apart from the log and delivery frequency configurations, you can decide to activate the stream when making the request, or later. Note that only active streams collect and send logs to their destinations. See Activate a stream.

Query Params

activate

boolean

Defaults to false

Activates the stream at the time of the request, false by default. When you edit or patch an active stream, you need to set this to true.

Body Params

collectMidgress

boolean

Defaults to false

For DS-managed streams. Set to true to collect midgress traffic data within the Akamai platform, such as between two edge servers. Enable logging midgress data to get numeric values in the second place of the log line that indicate if the request was processed within the Akamai platform. When you Get a stream that logs midgress traffic, the response returns collectMidgress as true and lists the isMidgress data set field with other fields. See Midgress traffic for details. The DataStream behavior property configuration overrides this value. If this feature is not enabled on your account, contact the Akamai support team.

contractId

string

required

Identifies the contract that has access to the product.

datasetFields

array of objects

required

Identifies data set fields that you want to receive in logs. For the STRUCTURED format, the order of the identifiers defines how these fields' values appear in the log lines. See Data set parameters for the complete list of the fields you can choose.

Dataset fields*

deliveryConfiguration

object

required

Configures log lines, log file format, names of the log files sent to a destination, and delivery frequency for these files.

destination

required

The destination configuration in the stream to send logs. See Destinations for details and features available for each destination.

enableCompleteness

boolean

Set to true to create a stream optimized for log completeness. See Latency profiles for details.

enableFasterLatency

boolean

Defaults to true

Set to true to create a stream with the latency profile optimized for lower latency. This is the default latency profile if enableFasterLatency or enableCompleteness isn’t specified. See Latency profiles for details.

groupId

integer

required

Identifies the group that has access to the product and this stream configuration.

notificationEmails

array of strings

length ≥ 0

Email addresses where you want to send notifications about the stream's activations and deactivations. By omitting this or specifying an empty array, you can activate or deactivate the stream without notifications.

Notification emails

properties

array of objects

required

Identifies the properties that belong to the same product and you want to monitor in the stream. Note that a stream can only log data for active properties. You can activate a property in the Property Manager API.

Properties*

samplingPercentage

integer

1 to 100

For DS-managed streams. The percentage of sample data the stream collects and sends to your destination. The DataStream behavior property configuration overrides this value.

streamName

string

required

length ≤ 1000

The stream's name.

webSocketEnabled

boolean

Set to true to log WebSocket data. Logging this data requires adding the webSockets behavior in your property configuration.

Response

201The response confirms the stream has been created and returns its details.