Update a stream

put

https://api.linode.com/{apiVersion}/monitor/streams/{streamId}

Update an existing logs stream. You can't update a stream's type. This operation can only be accessed by account users with unrestricted access. Talk to your local account administrator about access management.

🚧
By using this service, you acknowledge your obligations under the United States Department of Justice Bulk Sensitive Data Transaction Rule ("BSD Rule"). You also agree that you will not use the service to transfer, onward transfer, or otherwise make accessible any United States government-related data or bulk United States sensitive personal data to countries of concern or a covered person, as each of those terms and concepts are defined in the BSD Rule. Anyone using the service is solely responsible for compliance with the BSD Rule.

Permissions and scopes

To call this operation, you need permissions, based on the model you're using:

OAuth scopes. Your user needs these scopes assigned. Learn more.
- Scopes: monitor:read_write

CLI

linode-cli streams update 890 \
--label Logs stream for Managed Databases \
--status inactive \
--destinations 12345

Learn more

Path Params

apiVersion

string

enum

required

Enum Call either the v4 URL, or v4beta for operations still in Beta.

Allowed:

streamId

integer

required

The unique identifier assigned to the stream. Run the List streams operation and store the id for the applicable one.

Body Params

destinations

array of integers

length ≤ 1

The unique identifier for a new sync point to receive logs data. Run the List destinations operation and store the id value for the applicable destination.

📘
Currently, you can only specify a single destination for a stream. If you include a value in this array, it will overwrite an existing destination.

destinations

details

object

Additional details for the stream, based on its type. To view your current type, run the Get a stream to target your specific stream. Consider these points when updating a stream:

This object only applies to streams with a type of lke_audit_logs. Leave it out of requests that use a type of audit_logs.
Any existing settings need to be included to maintain them. For example, if you're adding new cluster_ids to the stream, you also need to include any existing ones to maintain them. Run the Get a stream operation to review the existing details settings for a stream.
You can't change the type of an existing stream.

label

string

The name of the stream. This is used for display purposes in Akamai Cloud Manager.

status

string

enum

Defaults to active

The availability status of the stream.

Allowed:

Responses

200The logs stream was updated.

defaultSee Errors for the range of possible error response codes.