Edit, stop, or delete a stream
Change the settings of a Data Stream stream, stop it and start it again, or delete it, in Azion Console or with the Azion API.
You can edit, stop, or delete a Data Stream stream from Azion Console or with the Azion API. To create a stream, refer to the Data Stream quickstart.
A stopped stream keeps its settings and sends nothing until you start it again. A deleted stream is gone with its settings. For every field you can change, refer to Stream settings.
Select your interface once. The prerequisites and every task below show only that path.
Prerequisites
- A stream on your Azion account. To create one, refer to the Data Stream quickstart.
- The Edit Data Stream permission. With View Data Stream only, you can see the streams but not edit, stop, or delete them. For details, refer to Stream settings.
- Access to Azion Console. To sign in, refer to How to access Azion Console.
- An account with fewer than 3,000 workloads. At 3,000 workloads or more, the Console blocks the stream forms, and you manage streams through the API only.
Edit a stream
An edit keeps the stream’s ID and changes only the settings you save. Saving checks the format of the fields, not the endpoint, so a wrong credential shows up later as failed sends.
To edit a stream with the API, send a PATCH request with only the keys you change. This example renames the stream. Replace <stream-id> with the ID of your stream:
The API answers 200 with the stored stream:
The name is the one you sent, and last_modified moves forward. The data source, transforms, and endpoint stay as they were. To replace the whole stream, send a PUT request with the keys a create requires: name, inputs, transform, and outputs. For the body of each key, refer to Stream settings.
Edits take a few minutes to propagate. Saving an active stream that uses sampling deactivates every other stream on the account. After you change the endpoint, check the next sends in Real-Time Events: each send is recorded with the status code the endpoint returned.
Stop a stream
A stopped stream keeps its settings, so you can start it again without configuring it.
To stop a stream with the API, send a PATCH request that sets active to false:
The API answers 200 with the stored stream:
The stream reads "active": false, and its other settings are unchanged. To start the stream again, send the same request with {"active": true}.
A change of active state takes effect after one to two minutes. During that window, the stream can keep sending. After it, Real-Time Events records no further send from the stopped stream to its endpoint.
Delete a stream
Deleting a stream removes it and its settings. A deleted stream cannot be restored: the Console warns Once confirmed, this action can't be reversed. To pause a stream and keep its settings, stop it instead.
To delete a stream with the API, send a DELETE request:
The API answers 200:
The "state": "executed" value confirms that the API deleted the stream.