Présentation générale

Temporarily pauses an active stream to stop data ingestion while preserving your stream configuration. Use this endpoint when you need to temporarily halt data delivery without deleting the stream.

Key behaviors:

• Data delivery stops immediately
• Stream configuration is preserved
• Can be resumed later using the Activate Stream endpoint
• Stream status changes from active à paused

Endpoint

Send a POST request to pause an active stream.

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

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 pause

Example Request

cURL

curl -X POST "https://api.quicknode.com/streams/rest/v1/streams/f6ad6459-b5ad-4183-b370-1c1388e47e83/pause" \
  -H "accept: application/json" \
  -H "x-api-key: YOUR_API_KEY"

CLI

qn stream pause f6ad6459-b5ad-4183-b370-1c1388e47e83 -o json

JavaScript

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

fetch('https://api.quicknode.com/streams/rest/v1/streams/f6ad6459-b5ad-4183-b370-1c1388e47e83/pause', {
  method: 'POST',
  headers: headers
})
  .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/pause"

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

response = requests.post(url, headers=headers)
print(response.json())

Ruby

require "uri"
require "net/http"

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

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

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

SDK (JS)

import { QuicknodeSdk } from "@quicknode/sdk"

const qn = new QuicknodeSdk({ apiKey: "YOUR_API_KEY" })
await qn.streams.pauseStream("f6ad6459-b5ad-4183-b370-1c1388e47e83")

console.log("Stream paused")

SDK (Python)

import asyncio
from quicknode_sdk import QuicknodeSdk, SdkFullConfig

async def main():
    qn = QuicknodeSdk(SdkFullConfig(api_key="YOUR_API_KEY"))
    await qn.streams.pause_stream("f6ad6459-b5ad-4183-b370-1c1388e47e83")
    print("Stream paused")

asyncio.run(main())

SDK (Ruby)

require "quicknode_sdk"

qn = QuicknodeSdk::SDK.from_config(api_key: "YOUR_API_KEY")
qn.streams.pause_stream(id: "f6ad6459-b5ad-4183-b370-1c1388e47e83")

puts "Stream paused"

SDK (Rust)

use quicknode_sdk::{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())?;
    qn.streams.pause_stream("f6ad6459-b5ad-4183-b370-1c1388e47e83").await?;

    println!("Stream paused");
    Ok(())
}

Réponse

On success, the API returns a confirmation message.

{
  "code": 200,
  "msg": "Stream paused successfully",
  "data": null
}

Champs de réponse

Champ	Type	Description
code	nombre	HTTP status code (200 for success)
msg	chaîne de caractères	Confirmation message
données	null	No additional data returned