Skip to main content

Update Profile

Route

/v2/streaming/profiles/{profile.id}

Description

Update an existing streaming profile with the provided configuration.

Method

PATCH

Inputs

ParameterTypeRequiredDescription
profile.idstringYesThe unique identifier of the profile
namestringYesHuman-readable name for the profile
descriptionstringNoDetailed description of the profile
sourcesarray[Source]YesData sources to stream
destination_idstringYesTarget destination ID
count_thresholdintegerNoBatch size threshold
delay_thresholdstringNoBatch delay threshold
statestringNoProfile state (active, stopped, paused)
scope_idstringNoScope identifier
configobjectNoProfile configuration

Query Parameters

ParameterTypeRequiredDescription
fieldsstringNoSpecifies which fields to update

Output

FieldTypeDescription
resourcesarray[Profile]Array containing the updated profile
errorsarray[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": []
}