Streams

Number of APIs: 7

1. Create a stream

POST https://{{host}}/datastream-config-api/v2/log/streams

Creates a stream configuration. Within a stream configuration, you can select properties 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 use in the https://{hostname}/datastream-config-api/v2/log/streams/{streamId} endpoint URL. Apart from the log and delivery frequency configurations, you can decide whether to activate the stream on making the request or later using the activate parameter. Note that only active streams collect and send logs to their destinations. See Activate a stream.

---

2. List streams

GET https://{{host}}/datastream-config-api/v2/log/streams

Returns the latest versions of the stream configurations for all groups within your account. You can use the groupId parameter to view the latest versions of all configurations in a specific group, and up to five property names as the propertyName parameter to get streams for specific properties.

---

3. View upload metrics

GET https://{{host}}/datastream-config-api/v2/log/streams/metrics?start={{start}}&end={{end}}

Returns aggregated metrics for log file uploads, including success or failure upload counts, upload latency, and the volume of data uploaded in the stream. Set the start and end dates to get metrics from a specific time range, and aggregationInterval to group data by time intervals.

---

4. Get a stream

GET https://{{host}}/datastream-config-api/v2/log/streams/:streamId

Returns information about any version of a stream, including details about the monitored properties, logged data set fields, and log delivery destination. If you omit the version query parameter, this operation returns the last version of the stream.

---

5. Edit a stream

PUT https://{{host}}/datastream-config-api/v2/log/streams/:streamId

Updates the latest version of a stream. Running this operation creates a version of the stream that replaces the existing one. Note that only active streams collect and send logs to their destinations. You need to set the activate parameter to true while patching active streams, and optionally for inactive streams if you want to activate them upon request. See Version management and Activate a stream.

---

6. Patch a stream

PATCH https://{{host}}/datastream-config-api/v2/log/streams/:streamId

Updates selected details of an existing stream. Running this operation using JSON Patch syntax creates a stream version that replaces the current one. Currently you can patch a stream using only the REPLACE operation. When updating configuration objects such as destination or deliveryConfiguration, pass a complete object to avoid overwriting current details with default values for omitted members such as tags, uploadFilePrefix, and uploadFileSuffix. Note that only active streams collect and send logs to their destinations. You need to set the activate parameter to true while patching active streams, and optionally for inactive streams if you want to activate them upon request. See Patching streams for details.

---

7. Delete a stream

DELETE https://{{host}}/datastream-config-api/v2/log/streams/:streamId

Deletes a deactivated stream. Deleting a stream means that you can't activate this stream again, and that you stop receiving logs for the properties that this stream monitors. Before deleting any stream, you need to deactivate it first. See Deactivate a stream.

---