Présentation générale

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

remarque

Le network, dataset, et 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}

Paramètres de chemin d'accès

Paramètre	Type	Obligatoire	Description
id	chaîne de caractères	Oui	The unique identifier (UUID) of the stream to update

Paramètres de requête

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

Paramètre	Type	Obligatoire	Description
nom	chaîne de caractères	Non	A new name for your stream
filter_function	chaîne de caractères	Non	Base64-encoded JavaScript filter function
start_range	entier	Non	Starting block number
end_range	entier	Non	Ending block number
dataset_batch_size	entier	Non	Number of blocks to batch per delivery
statut	chaîne de caractères	Non	active or paused
elastic_batch_enabled	booléen	Non	Auto-adjust batch size to 1 near chain tip
fix_block_reorgs	entier	Non	1 to enable reorg detection
keep_distance_from_tip	entier	Non	Blocks to stay behind chain tip
notification_email	chaîne de caractères	Non	Email for stream termination alerts
destination	chaîne de caractères	Non	webhook, s3, azure, or postgres
destination_attributes	objet	Non	Configuration for selected destination
extra_destinations	tableau	Non	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

Paramètre	Type	Obligatoire	Description
url	chaîne de caractères	Oui	Webhook endpoint URL
compression	chaîne de caractères	Oui	none or gzip
max_retry	entier	Oui	Max retry attempts
retry_interval_sec	entier	Oui	Seconds between retries
post_timeout_sec	entier	Oui	Request timeout in seconds
headers	objet	Non	Custom headers as key-value pairs
mtls	booléen	Non	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	chaîne de caractères	Non	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

Paramètre	Type	Obligatoire	Description
endpoint	chaîne de caractères	Oui	S3 endpoint (e.g., s3.amazonaws.com)
bucket	chaîne de caractères	Oui	Bucket name
secret_key	chaîne de caractères	Oui	S3 secret key
access_key	chaîne de caractères	Non	S3 access key
object_prefix	chaîne de caractères	Non	Prefix for object keys
file_compression_type	chaîne de caractères	Oui	none or gzip
file_type	chaîne de caractères	Oui	.json
max_retry	entier	Oui	Max retry attempts
retry_interval_sec	entier	Oui	Seconds between retries
use_ssl	booléen	Oui	Enable SSL

Azure

Paramètre	Type	Obligatoire	Description
storage_account	chaîne de caractères	Oui	Azure storage account name
container	chaîne de caractères	Oui	Container name
sas_token	chaîne de caractères	Oui	Shared Access Signature token
blob_prefix	chaîne de caractères	Non	Prefix for blob names
file_compression_type	chaîne de caractères	Oui	none or gzip
file_type	chaîne de caractères	Oui	.json
max_retry	entier	Oui	Max retry attempts
retry_interval_sec	entier	Oui	Seconds between retries

PostgreSQL

Paramètre	Type	Obligatoire	Description
host	chaîne de caractères	Oui	Database host
port	entier	Oui	Database port
username	chaîne de caractères	Oui	Database username
password	chaîne de caractères	Oui	Database password
table_name	chaîne de caractères	Oui	Target table name
sslmode	chaîne de caractères	Oui	require or disable
max_retry	entier	Oui	Max retry attempts
retry_interval_sec	entier	Oui	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(())
}

Réponse

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

Champs de réponse

Champ	Type	Description
id	chaîne de caractères	Unique stream identifier (UUID)
nom	chaîne de caractères	Stream name
network	chaîne de caractères	Blockchain network
dataset	chaîne de caractères	Dataset type
region	chaîne de caractères	Deployment region
filter_function	chaîne de caractères	Base64-encoded filter function (if configured)
start_range	entier	Starting block number
end_range	entier	Ending block number (null for continuous)
dataset_batch_size	entier	Number of blocks per batch
elastic_batch_enabled	booléen	Whether elastic batching is enabled
fix_block_reorgs	entier	Reorg detection setting (1 = enabled)
keep_distance_from_tip	entier	Blocks to stay behind chain tip
destination	chaîne de caractères	Destination type (webhook, s3, azure, postgres)
destination_attributes	objet	Destination configuration (varies by type)
statut	chaîne de caractères	Stream status (active or paused)
séquence	entier	Last delivered block from the data range
current_hash	chaîne de caractères	Hash of the current block being processed
notification_email	chaîne de caractères	Email for stream termination alerts
extra_destinations	tableau	Additional destinations (if configured)
created_at	chaîne de caractères	Stream creation timestamp (ISO 8601)
date_de_mise_à_jour	chaîne de caractères	Last update timestamp (ISO 8601)

remarque

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