Edit a stream

put

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

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 collect and send logs to their destinations. You need to set the activate parameter to true while patching active streams, and optionally for inactive streams if you want to activate them upon request. See Version management and Activate a stream.

Path Params

streamId

integer

required

Uniquely identifies the 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

collectMidgress

boolean

Defaults to false

Set to true for every edit operation 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.

datasetFields*

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

A collection of destination configurations for the stream.

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.

notificationEmails

properties

array of objects

required

Identifies the properties that belong to the same product, and you want to monitor in the stream. Note that only streams belonging to active properties can log data. See Activate a property in Property Manager.

properties*

streamName

string

required

length ≤ 1000

The name of the stream.

Response

200The response confirms the stream has been updated and returns its details.