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}

경로 매개변수

매개변수	유형	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.

매개변수	유형	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
알림 이메일	문자열	아니요	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.

웹훅
S3
Azure
PostgreSQL

매개변수	유형	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.

매개변수	유형	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

매개변수	유형	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

매개변수	유형	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"
}

응답 필드

분야	유형	설명
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
알림 이메일	문자열	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​

답변​

응답 필드​

개요