PUT /api/v1/logStreams/{logStreamId}
Replaces the Log Stream object properties for a given ID.
This operation is typically used to update the configuration of a Log Stream.
Depending on the type of Log Stream you want to update, certain properties can't be modified after the Log Stream is initially created.
Use the Retrieve the Log Stream Schema for the schema type request to determine which properties you can update for the specific Log Stream type.
Log Stream properties with the "writeOnce" : true attribute can't be updated after creation.
You must still specify these writeOnce properties in the request body with the original values in the PUT request.
Note: You don't have to specify properties that have both the
"writeOnce": trueand the"writeOnly": trueattributes in the PUT request body. These property values are ignored even if you add them in the PUT request body.
Servers
- https://{yourOktaDomain}
Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
logStreamId |
String | Yes |
Unique identifier for the Log Stream |
Request headers
| Name | Type | Required | Description |
|---|---|---|---|
Content-Type |
String | Yes |
The media type of the request body.
Default value: "application/json" |
Request body fields
| Name | Type | Required | Description |
|---|---|---|---|
name |
String | Yes |
Unique name for the Log Stream object |
type |
String | Yes |
Specifies the streaming provider used Supported providers:
Select the provider type to see provider-specific configurations in the Possible values:
|
How to start integrating
- Add HTTP Task to your workflow definition.
- Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
- Click Test request to test run your request to the API and see the API's response.