Edit an AnswerX stream

put

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

Updates the latest version of an AnswerX stream. Each time you edit a stream, its version number increments. Note that only active streams collect and send logs to their destinations. You need to set the activate parameter to true while editing 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

Provides information that you need to specify when editing 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.

datasetFields*

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

A collection of destination configurations for the stream.

serviceSubletterIds

array of objects

required

length ≥ 1

Identifies the AnswerX Recursive DNS Service IDs (SSIDs) that you want to monitor in the stream. Get the ssid values from List AnswerX service instances.

Service instances*

ssid

integer

required

Identifies the AnswerX Recursive DNS service instance (subletter ID).

streamName

string

required

length ≤ 1000

The stream's name.

Response

Language

URL

Loading…

Response

Choose an example:

application/json

200The response shows the updated stream.