Resumen

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

nota

El red, dataset, y 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}

Parámetros de ruta

Parameter	Tipo	Obligatorio	Descripción
id	cadena	Sí	The unique identifier (UUID) of the stream to update

Parámetros de la solicitud

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

Parameter	Tipo	Obligatorio	Descripción
nombre	cadena	No	A new name for your stream
filter_function	cadena	No	Base64-encoded JavaScript filter function
start_range	entero	No	Starting block number
fin_rango	entero	No	Ending block number
tamaño_del_lote_del_conjunto_de_datos	entero	No	Number of blocks to batch per delivery
estado	cadena	No	active or paused
elastic_batch_enabled	booleano	No	Auto-adjust batch size to 1 near chain tip
fix_block_reorgs	entero	No	1 to enable reorg detection
mantener_distancia_respecto_a_la_punta	entero	No	Blocks to stay behind chain tip
notification_email	cadena	No	Email for stream termination alerts
destination	cadena	No	webhook, s3, azure, or postgres
destination_attributes	objeto	No	Configuration for selected destination
extra_destinations	matriz	No	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

Parameter	Tipo	Obligatorio	Descripción
url	cadena	Sí	Webhook endpoint URL
compression	cadena	Sí	none or gzip
max_retry	entero	Sí	Max retry attempts
retry_interval_sec	entero	Sí	Seconds between retries
post_timeout_sec	entero	Sí	Request timeout in seconds
headers	objeto	No	Custom headers as key-value pairs
mtls	booleano	No	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	cadena	No	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.

S3

Parameter	Tipo	Obligatorio	Descripción
endpoint	cadena	Sí	S3 endpoint (e.g., s3.amazonaws.com)
bucket	cadena	Sí	Bucket name
secret_key	cadena	Sí	S3 secret key
access_key	cadena	No	S3 access key
object_prefix	cadena	No	Prefix for object keys
file_compression_type	cadena	Sí	none or gzip
file_type	cadena	Sí	.json
max_retry	entero	Sí	Max retry attempts
retry_interval_sec	entero	Sí	Seconds between retries
use_ssl	booleano	Sí	Enable SSL

Azure

Parameter	Tipo	Obligatorio	Descripción
storage_account	cadena	Sí	Azure storage account name
container	cadena	Sí	Container name
sas_token	cadena	Sí	Shared Access Signature token
blob_prefix	cadena	No	Prefix for blob names
file_compression_type	cadena	Sí	none or gzip
file_type	cadena	Sí	.json
max_retry	entero	Sí	Max retry attempts
retry_interval_sec	entero	Sí	Seconds between retries

PostgreSQL

Parameter	Tipo	Obligatorio	Descripción
host	cadena	Sí	Database host
port	entero	Sí	Database port
username	cadena	Sí	Database username
password	cadena	Sí	Database password
table_name	cadena	Sí	Target table name
sslmode	cadena	Sí	require or disable
max_retry	entero	Sí	Max retry attempts
retry_interval_sec	entero	Sí	Seconds between retries

Example Request

cURL

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
    }
  }'

CLI

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

JavaScript

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))

Python

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())

Ruby

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

SDK (JS)

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)

SDK (Python)

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())

SDK (Ruby)

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"]}"

SDK (Rust)

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(())
}

Respuesta

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"
}

Campos de respuesta

Campo	Tipo	Descripción
id	cadena	Unique stream identifier (UUID)
nombre	cadena	Stream name
red	cadena	Blockchain network
dataset	cadena	Dataset type
region	cadena	Deployment region
filter_function	cadena	Base64-encoded filter function (if configured)
start_range	entero	Starting block number
fin_rango	entero	Ending block number (null for continuous)
tamaño_del_lote_del_conjunto_de_datos	entero	Number of blocks per batch
elastic_batch_enabled	booleano	Whether elastic batching is enabled
fix_block_reorgs	entero	Reorg detection setting (1 = enabled)
mantener_distancia_respecto_a_la_punta	entero	Blocks to stay behind chain tip
destination	cadena	Destination type (webhook, s3, azure, postgres)
destination_attributes	objeto	Destination configuration (varies by type)
estado	cadena	Stream status (active or paused)
secuencia	entero	Last delivered block from the data range
current_hash	cadena	Hash of the current block being processed
notification_email	cadena	Email for stream termination alerts
extra_destinations	matriz	Additional destinations (if configured)
created_at	cadena	Stream creation timestamp (ISO 8601)
actualizado_el	cadena	Last update timestamp (ISO 8601)

nota

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