Update Profile
Route
/v2/streaming/profiles/{profile.id}
Description
Update an existing streaming profile with the provided configuration.
Method
PATCH
Inputs
| Parameter | Type | Required | Description |
|---|---|---|---|
profile.id | string | Yes | The unique identifier of the profile |
name | string | Yes | Human-readable name for the profile |
description | string | No | Detailed description of the profile |
sources | array[Source] | Yes | Data sources to stream |
destination_id | string | Yes | Target destination ID |
count_threshold | integer | No | Batch size threshold |
delay_threshold | string | No | Batch delay threshold |
state | string | No | Profile state (active, stopped, paused) |
scope_id | string | No | Scope identifier |
config | object | No | Profile configuration |
Query Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
fields | string | No | Specifies which fields to update |
Output
| Field | Type | Description |
|---|---|---|
resources | array[Profile] | Array containing the updated profile |
errors | array[Error] | Any errors encountered |
Rate Limit
- 60 requests per minute per API key
- 5 concurrent requests per endpoint
Example Response
{
"resources": [
{
"id": "profile-123",
"name": "Updated Security Stream",
"description": "Updated security incidents stream",
"sources": [
{
"type": "incidents"
}
],
"destination_id": "dest-456",
"state": "paused"
}
],
"errors": []
}