概覽

Permanently deletes a stream by its unique ID. This action removes the stream configuration and stops all data delivery to its destination.

Key considerations:

• This action cannot be undone
• All stream configuration will be permanently deleted
• Data delivery stops immediately
• Historical delivery data is not affected

warning

This is a destructive action. Make sure you want to permanently remove this stream before proceeding.

Endpoint

Send a DELETE request to remove a specific stream.

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

路徑參數

參數	類型	Required	說明
id	字串	是的	The unique identifier (UUID) of the stream to delete

Example Request

cURL

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

CLI

qn stream delete 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', {
  method: 'DELETE',
  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"

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

response = requests.delete(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")
https = Net::HTTP.new(url.host, url.port)
https.use_ssl = true

request = Net::HTTP::Delete.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.deleteStream("f6ad6459-b5ad-4183-b370-1c1388e47e83")

console.log("Stream deleted")

SDK (Python)

import asyncio
from quicknode_sdk import QuicknodeSdk, SdkFullConfig

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

asyncio.run(main())

SDK (Ruby)

require "quicknode_sdk"

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

puts "Stream deleted"

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.delete_stream("f6ad6459-b5ad-4183-b370-1c1388e47e83").await?;

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

回應

On success, the API returns a confirmation message.

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

Response Fields

領域	類型	說明
程式碼	數字	HTTP status code (200 for success)
msg	字串	Confirmation message
資料	null	No additional data returned