Create an Edge DNS stream

post

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

Creates a stream configuration for Edge DNS. You can choose the zones 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

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

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.

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

streamName

string

required

length ≤ 1000

The stream's name.

zones

array of objects

required

Identifies the Edge DNS zones that you want to monitor in the stream.

Zones*

Response

Response body

object

Details the latest configuration version of an Edge DNS stream. It provides descriptions of the data set fields selected in the version, identifiers of zones they collect logs for, configuration of the destination where they deliver logs, and structure of these log lines. It also indicates if this version is active.

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.

datasetFields

array of objects

required

Lists currently selected data set fields the stream monitors in logs. The order of the identifiers determines how these fields' values appear in log lines.

datasetFields*

object

datasetFieldId

integer

required

Identifies the field.

datasetFieldJsonKey

string

required

Specifies the JSON key for the field in a log line. You can get this value only when you run the List data set fields or Get a stream operation for a stream in the JSON format.

datasetFieldName

string

required

The data set field's name.

deliveryConfiguration

object

required

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

fieldDelimiter

string

enum

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

enum

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.

streamId

integer

required

Identifies the stream.

streamName

string

required

The stream's name.

streamStatus

string

enum

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.

zones

array of objects

required

Identifies the Edge DNS zones you monitor in the stream.

zones*

object

zoneId

integer

required

The identifier of the zone.

zoneName

string

required

The zone's descriptive label.

Language

URL


xxxxxxxxxx
17
1
curl --request POST \
2
     --url https://hostname/datastream-config-api/v3/log/edns/streams \
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
43
}
1
{
2
  "contractId": "K-0N7RAK7",
3
  "createdBy": "jperez",
4
  "createdDate": "2023-09-05T07:41:45Z",
5
  "datasetFields": [
6
    {
7
      "datasetFieldId": 5001,
8
      "datasetFieldJsonKey": "eDnsSize",
9
      "datasetFieldName": "EDNS0 size"
10
    }
11
  ],
12
  "deliveryConfiguration": {
13
    "fieldDelimiter": "SPACE",
14
    "format": "STRUCTURED",
15
    "frequency": {
16
      "intervalInSeconds": 30
17
    },
18
    "uploadFilePrefix": "ak",
19
    "uploadFileSuffix": "ds"
20
  },
21
  "destination": {
22
    "accountName": "Internet Company",
23
    "compressLogs": true,
24
    "containerName": "logs",
25
    "destinationType": "AZURE",
26
    "displayName": "azure_destination",
27
    "path": "logs/edgelogs/{%Y/%m/%d/%H/%M/%S}"
28
  },
29
  "groupId": 12345,
30
  "latestVersion": 1,
31
  "modifiedBy": "szhang",
32
  "modifiedDate": "2023-09-05T07:41:45Z",
33
  "streamId": 54321,
34
  "streamName": "diagnostics-log-stream",

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