Deactivate a stream

Deactivates the latest version of a stream. Deactivating a stream means that you stop receiving logs for the properties that this stream monitors and changes status to DEACTIVATED in approximately an hour. If you want to start receiving log files again, you can activate the stream at any time using the Activate a stream operation.

Recipes
🦉
Deactivate a stream (v2)
Open Recipe
Path Params
integer
required

Uniquely identifies the stream.

Response

Response body
object
boolean

Indicates if you've opted to capture midgress traffic within the Akamai platform, such as between two edge servers.

string
required

Identifies the contract that the stream belongs to.

string
required

The username who created the stream.

date-time
required

An ISO 8601 timestamp marking when the stream was created.

datasetFields
array of objects
required

A list of data set fields selected that the stream monitors in logs. The order of the identifiers define how the value for these fields appear in the log lines.

datasetFields*
object
integer
required

Identifies the field.

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.

string
required

A name of the data set field.

deliveryConfiguration
object
required

The configuration of log lines, names of the files sent to a destination, and delivery frequency for these files.

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

string
required

The format in which you want to receive log files. STRUCTURED or JSON are the currently available formats.

STRUCTURED JSON

frequency
object
required

The frequency of collecting logs from each uploader and sending these logs to a destination.

string
Defaults to ak

The prefix of the log file that you want to send to a object-based destination. It's a string of at most 200 characters. This member supports Dynamic time variables. If unspecified, it defaults to ak.

string
Defaults to ds

The suffix of the log file that you want to send to a object-based destination. This member supports Dynamic time variables. It's a static string of at most 10 characters. If unspecified, it defaults to ds.

required

Provides detailed information about the destination's configuration in the stream to send logs.

integer
required

Identifies the group that has access to the product and that you created the stream configuration for. When editing a stream, the value you pass is ignored as you can't change the group for an existing stream.

integer
required

Identifies the latest configuration version of the stream.

string
required

The username who modified the stream.

date-time
required

The date and time in the ISO 8601 format when the stream was modified.

notificationEmails
array of strings

A comma-delimited list of email addresses where the system sends notifications about activations and deactivations of the stream.

notificationEmails
string
required

The ID of the product that you created stream for.

properties
array of objects
required

Identifies the properties that you monitor in the stream.

properties*
object
integer
required

The identifier of the property.

string
required

The descriptive label for the property.

integer
required

Identifies the stream.

string
required

The name of the stream.

string
required

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

INACTIVE ACTIVATING ACTIVATED DEACTIVATING DEACTIVATED

integer
required

Identifies the configuration version of the stream.

Language
Authentication
URL