Update a Stream – Streams REST API

概述

Updates the configuration of an existing stream. Use this endpoint to modify a stream's name, filter function, destination, destination attributes, extra destinations, batch size, metadata settings, reorg handling, distance-from-tip, notification email, and other configuration options without needing to delete and recreate the stream.

Key capabilities:

Change webhook URL or destination credentials
Update filter functions on-the-fly
Switch compression settings
Adjust retry parameters
Add or modify extra destinations
Update batch size and elastic batching settings

note

该 网络, dataset，以及 region fields cannot be changed after stream creation. To change these, create a new stream instead.

Endpoint

Send a PATCH request to update an existing stream.

PATCH https://api.quicknode.com/streams/rest/v1/streams/{id}

路径参数

Parameter	类型	Required	描述
id	字符串	是	The unique identifier (UUID) of the stream to update

Request Parameters

All body parameters are optional. Only include the fields you want to update.

Parameter	类型	Required	描述
名称	字符串	不	A new name for your stream
filter_function	字符串	不	Base64-encoded JavaScript filter function
start_range	整数	不	Starting block number
end_range	整数	不	Ending block number
dataset_batch_size	整数	不	Number of blocks to batch per delivery
状态	字符串	不	active or paused
elastic_batch_enabled	布尔型	不	Auto-adjust batch size to 1 near chain tip
fix_block_reorgs	整数	不	1 to enable reorg detection
keep_distance_from_tip	整数	不	Blocks to stay behind chain tip
notification_email	字符串	不	Email for stream termination alerts
destination	字符串	不	webhook, s3, azure, or postgres
destination_attributes	对象	不	Configuration for selected destination
extra_destinations	数组	不	Additional destinations

Destination Attributes

When updating destination attributes, the configuration options vary based on the selected destination type. Select a tab below to view the attributes for each destination.

Webhook
S3
Azure
PostgreSQL

Parameter	类型	Required	描述
url	字符串	是	Webhook endpoint URL
compression	字符串	是	none or gzip
max_retry	整数	是	Max retry attempts
retry_interval_sec	整数	是	Seconds between retries
post_timeout_sec	整数	是	Request timeout in seconds
headers	对象	不	Custom headers as key-value pairs
mtls	布尔型	不	Enable mutual TLS: Quicknode authenticates to your endpoint with its client certificate. Requires an HTTPS URL. Send false explicitly to disable. See the Webhook destination page for server setup.
ssl_ca_pem	字符串	不	CA certificate (PEM) used to verify your endpoint's server certificate when it is signed by a private CA. Send an empty string to clear.

For mTLS server configuration and how to download the Quicknode CA certificate, see Mutual TLS on the Webhook destination page.

Parameter	类型	Required	描述
endpoint	字符串	是	S3 endpoint (e.g., s3.amazonaws.com)
bucket	字符串	是	Bucket name
secret_key	字符串	是	S3 secret key
access_key	字符串	不	S3 access key
object_prefix	字符串	不	Prefix for object keys
file_compression_type	字符串	是	none or gzip
file_type	字符串	是	.json
max_retry	整数	是	Max retry attempts
retry_interval_sec	整数	是	Seconds between retries
use_ssl	布尔型	是	Enable SSL

Parameter	类型	Required	描述
storage_account	字符串	是	Azure storage account name
container	字符串	是	Container name
sas_token	字符串	是	Shared Access Signature token
blob_prefix	字符串	不	Prefix for blob names
file_compression_type	字符串	是	none or gzip
file_type	字符串	是	.json
max_retry	整数	是	Max retry attempts
retry_interval_sec	整数	是	Seconds between retries

Parameter	类型	Required	描述
host	字符串	是	Database host
port	整数	是	Database port
username	字符串	是	Database username
password	字符串	是	Database password
table_name	字符串	是	Target table name
sslmode	字符串	是	require or disable
max_retry	整数	是	Max retry attempts
retry_interval_sec	整数	是	Seconds between retries

Example Request

curl -X PATCH "https://api.quicknode.com/streams/rest/v1/streams/f6ad6459-b5ad-4183-b370-1c1388e47e83" \
  -H "accept: application/json" \
  -H "Content-Type: application/json" \
  -H "x-api-key: YOUR_API_KEY" \
  -d '{
    "name": "Updated Stream Name",
    "destination_attributes": {
      "url": "https://new-webhook.site",
      "compression": "gzip",
      "max_retry": 5,
      "retry_interval_sec": 2,
      "post_timeout_sec": 15,
      "mtls": true
    }
  }'

qn stream update f6ad6459-b5ad-4183-b370-1c1388e47e83 \
  --name "Updated Stream Name" \
  --notification-email alice@example.com \
  -o json

const headers = new Headers()
headers.append('accept', 'application/json')
headers.append('Content-Type', 'application/json')
headers.append('x-api-key', 'YOUR_API_KEY')

const body = JSON.stringify({
  name: 'Updated Stream Name',
  destination_attributes: {
    url: 'https://new-webhook.site',
    compression: 'gzip',
    max_retry: 5,
    retry_interval_sec: 2,
    post_timeout_sec: 15,
    mtls: true
  }
})

fetch('https://api.quicknode.com/streams/rest/v1/streams/f6ad6459-b5ad-4183-b370-1c1388e47e83', {
  method: 'PATCH',
  headers: headers,
  body: body
})
  .then(response => response.json())
  .then(data => console.log(data))
  .catch(error => console.error('Error:', error))

import requests

url = "https://api.quicknode.com/streams/rest/v1/streams/f6ad6459-b5ad-4183-b370-1c1388e47e83"

payload = {
    "name": "Updated Stream Name",
    "destination_attributes": {
        "url": "https://new-webhook.site",
        "compression": "gzip",
        "max_retry": 5,
        "retry_interval_sec": 2,
        "post_timeout_sec": 15,
        "mtls": true
    }
}

headers = {
    "accept": "application/json",
    "Content-Type": "application/json",
    "x-api-key": "YOUR_API_KEY"
}

response = requests.patch(url, headers=headers, json=payload)
print(response.json())

require "uri"
require "net/http"
require "json"

url = URI("https://api.quicknode.com/streams/rest/v1/streams/f6ad6459-b5ad-4183-b370-1c1388e47e83")
https = Net::HTTP.new(url.host, url.port)
https.use_ssl = true

request = Net::HTTP::Patch.new(url)
request["accept"] = "application/json"
request["Content-Type"] = "application/json"
request["x-api-key"] = "YOUR_API_KEY"

request.body = {
  "name" => "Updated Stream Name",
  "destination_attributes" => {
    "url" => "https://new-webhook.site",
    "compression" => "gzip",
    "max_retry" => 5,
    "retry_interval_sec" => 2,
    "post_timeout_sec" => 15,
    "mtls" => true
  }
}.to_json

response = https.request(request)
puts response.body

import { QuicknodeSdk } from "@quicknode/sdk"

const qn = new QuicknodeSdk({ apiKey: "YOUR_API_KEY" })

const stream = await qn.streams.updateStream("f6ad6459-b5ad-4183-b370-1c1388e47e83", {
  name: "Updated Stream Name",
})

console.log(stream.id, stream.name)

import asyncio
from quicknode_sdk import QuicknodeSdk, SdkFullConfig

async def main():
    qn = QuicknodeSdk(SdkFullConfig(api_key="YOUR_API_KEY"))
    stream = await qn.streams.update_stream(
        id="f6ad6459-b5ad-4183-b370-1c1388e47e83",
        name="Updated Stream Name",
    )
    print(stream.id, stream.name)

asyncio.run(main())

require "quicknode_sdk"

qn = QuicknodeSdk::SDK.from_config(api_key: "YOUR_API_KEY")

stream = qn.streams.update_stream(
  id: "f6ad6459-b5ad-4183-b370-1c1388e47e83",
  name: "Updated Stream Name",
)

puts "#{stream["id"]} #{stream["name"]}"

use quicknode_sdk::{streams::UpdateStreamParams, QuicknodeSdk, SdkFullConfig};

#[tokio::main]
async fn main() -> Result<(), Box<dyn std::error::Error>> {
    let qn = QuicknodeSdk::new(&SdkFullConfig::builder().api_key("YOUR_API_KEY").build())?;

    let params = UpdateStreamParams {
        name: Some("Updated Stream Name".to_string()),
        ..Default::default()
    };
    let stream = qn.streams.update_stream("f6ad6459-b5ad-4183-b370-1c1388e47e83", &params).await?;

    println!("{} {}", stream.id, stream.name);
    Ok(())
}

On success, the API returns the updated stream object with all configuration and status information.

{
  "id": "f6ad6459-b5ad-4183-b370-1c1388e47e83",
  "name": "Updated Stream Name",
  "network": "ethereum-mainnet",
  "dataset": "block",
  "region": "usa_east",
  "filter_function": "ZnVuY3Rpb24gbWFpbihkYXRhKSB7Li4ufQ==",
  "start_range": 100,
  "end_range": 200,
  "dataset_batch_size": 1,
  "elastic_batch_enabled": true,
  "fix_block_reorgs": 0,
  "keep_distance_from_tip": 0,
  "destination": "webhook",
  "destination_attributes": {
    "url": "https://new-webhook.site",
    "compression": "gzip",
    "max_retry": 5,
    "retry_interval_sec": 2,
    "post_timeout_sec": 15,
    "mtls": true,
    "security_token": "qn_xxxxxxxxxxxxxx"
  },
  "status": "active",
  "sequence": 150,
  "current_hash": "0x1234567890abcdef...",
  "notification_email": null,
  "extra_destinations": [],
  "created_at": "2024-01-15T10:30:00Z",
  "updated_at": "2024-01-15T14:00:00Z"
}

Response Fields

Field	类型	描述
id	字符串	Unique stream identifier (UUID)
名称	字符串	Stream name
网络	字符串	Blockchain network
dataset	字符串	Dataset type
region	字符串	Deployment region
filter_function	字符串	Base64-encoded filter function (if configured)
start_range	整数	Starting block number
end_range	整数	Ending block number (null for continuous)
dataset_batch_size	整数	Number of blocks per batch
elastic_batch_enabled	布尔型	Whether elastic batching is enabled
fix_block_reorgs	整数	Reorg detection setting (1 = enabled)
keep_distance_from_tip	整数	Blocks to stay behind chain tip
destination	字符串	Destination type (webhook, s3, azure, postgres)
destination_attributes	对象	Destination configuration (varies by type)
状态	字符串	Stream status (active or paused)
序列	整数	Last delivered block from the data range
current_hash	字符串	Hash of the current block being processed
notification_email	字符串	Email for stream termination alerts
extra_destinations	数组	Additional destinations (if configured)
created_at	字符串	Stream creation timestamp (ISO 8601)
更新时间	字符串	Last update timestamp (ISO 8601)

note

Sensitive fields like secret_key (S3), sas_token (Azure), and password (PostgreSQL) are not returned in the response for security reasons.

Update a Stream – Streams REST API

概述​

Endpoint​

路径参数​

Request Parameters​

Destination Attributes​

Example Request​

回复​

Response Fields​

概述