Create a stream

post

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

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 destination to send these log files to. Get the streamId value from the response to use in the https://{hostname}/datastream-config-api/v2/log/streams/{streamId} endpoint URL. Apart from the log and delivery frequency configurations, you can decide whether to activate the stream on making the request or later using the activate parameter. 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 a stream or Patch a stream that is active, you need to set this member to true.

Body Params

Provides information that you need to specify when creating a stream configuration.

collectMidgress

boolean

Defaults to false

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. 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

Identifiers of the data set fields that you want to receive in logs. In case of STRUCTURED format, the order of the identifiers define how the value for these fields appear in the log lines. See Data set parameters for the complete list of the fields you can choose.

Dataset fields*

deliveryConfiguration

object

required

Provides information about the configuration of 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.

groupId

integer

required

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

notificationEmails

array of strings

A list of e-mail addresses where you want to send notifications about activations and deactivations of the stream. You can omit this member and 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 Property Manager.

Properties*

streamName

string

required

length ≤ 1000

The name of the stream.

Response

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