Edit an EdgeWorkers stream

put https://{hostname}/datastream-config-api/v3/log/ew/streams/{streamId}

Updates the latest version of an EdgeWorkers stream. When you edit a stream, you create a new configuration version with a higher number. 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 or patch an active stream, you need to set this to true.

Body Params

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.

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

streamName

string

required

length ≤ 1000

The stream's name.

Response

Response body

object

contractId

string

required

Identifies the contract the stream belongs to.

createdBy

string

required

The username who created the stream.

createdDate

date-time

required

An ISO 8601 timestamp marking when the stream was created.

deliveryConfiguration

object

required

The configuration of log filenames, and their delivery frequency to the destination.

fieldDelimiter

string

A delimiter that separates data set fields in the log lines, either SPACE or TAB. Set this only for the STRUCTURED log file format.

SPACE TAB

format

string

required

The format in which you want to receive log files. You can choose the STRUCTURED or JSON format for your stream.

STRUCTURED JSON

frequency

object

required

The frequency to collect logs from each uploader and send them to a destination.

uploadFilePrefix

string

length ≤ 200

Defaults to ak

The log filename prefix that you want to send to an object-based destination, up to 200 characters. This data supports Dynamic time variables. If unspecified, it defaults to ak.

uploadFileSuffix

string

length ≤ 10

Defaults to ds

The log filename suffix that you want to send to an object-based destination, up to 10 characters. This data supports Dynamic time variables. If unspecified, it defaults to ds.

destination

required

Details the destination's configuration in the stream to send logs.

groupId

integer

required

Identifies the group with access to the product, which you created the stream configuration for. You can write this data only once, when you initially create the stream.

latestVersion

integer

required

Identifies the stream's latest configuration version.

modifiedBy

string

required

The username who modified the stream.

modifiedDate

date-time

required

An ISO 8601 timestamp marking when the stream was modified.

notificationEmails

array of strings

length ≥ 0

Email addresses where the system sends notifications about activations and deactivations of the stream.

notificationEmails

streamId

integer

required

Identifies the stream.

streamName

string

required

The stream's name.

streamStatus

string

required

Indicates if the stream is INACTIVE, ACTIVATING, ACTIVATED, DEACTIVATING, or DEACTIVATED.

INACTIVE ACTIVATING ACTIVATED DEACTIVATING DEACTIVATED

streamVersion

integer

required

Identifies the stream's configuration version.

Language

URL


xxxxxxxxxx
17
1
curl --request PUT \
2
     --url https://hostname/datastream-config-api/v3/log/ew/streams/streamId \
3
     --header 'accept: application/json' \
4
     --header 'content-type: application/json' \
5
     --data '
6
{
7
  "deliveryConfiguration": {
8
    "format": "STRUCTURED",
9
    "frequency": {
10
      "intervalInSeconds": 30
11
    }
12
  },
13
  "destination": {
14
    "destinationType": "AZURE"
15
  }
16
}
17
'


xxxxxxxxxx
34
}
1
{
2
  "contractId": "C-0N7RAC7",
3
  "createdBy": "jperez",
4
  "createdDate": "2022-02-05T13:31:30Z",
5
  "deliveryConfiguration": {
6
    "fieldDelimiter": "SPACE",
7
    "format": "STRUCTURED",
8
    "frequency": {
9
      "intervalInSeconds": 30
10
    },
11
    "uploadFilePrefix": "logs",
12
    "uploadFileSuffix": "ds"
13
  },
14
  "destination": {
15
    "bucket": "datastream.akamai.com",
16
    "compressLogs": true,
17
    "destinationType": "S3",
18
    "displayName": "S3Destination",
19
    "path": "ds2-logs",
20
    "region": "ap-south-1"
21
  },
22
  "groupId": 54321,
23
  "latestVersion": 1,
24
  "modifiedBy": "szhang",
25
  "modifiedDate": "2022-02-05T13:31:30Z",

200The response shows the updated stream.