PATCH /streams/rest/v1/streams/{id} REST API Endpoint

Paramètres de chemin

ID

chaîne de caractères

OBLIGATOIRE

Chargement...

Paramètres du corps

nom

chaîne de caractères

Chargement...

filter_function

chaîne de caractères

Chargement...

start_range

entier

Chargement...

end_range

entier

Chargement...

dataset_batch_size

entier

Chargement...

statut

chaîne de caractères

Chargement...

activepaused

elastic_batch_enabled

booléen

Chargement...

fix_block_reorgs

entier

Chargement...

keep_distance_from_tip

entier

Chargement...

e-mail_de_notification

chaîne de caractères

Chargement...

destination

chaîne de caractères

Chargement...

webhooks3azurepostgres

destination_attributes

objet

OBLIGATOIRE

Chargement...

Chargement...

url

chaîne de caractères

OBLIGATOIRE

Chargement...

compression

chaîne de caractères

OBLIGATOIRE

Chargement...

aucungzip

headers

objet

Chargement...

key-value

chaîne de caractères

Chargement...

max_retry

entier

OBLIGATOIRE

Chargement...

retry_interval_sec

entier

OBLIGATOIRE

Chargement...

post_timeout_sec

entier

OBLIGATOIRE

Chargement...

Chargement...

endpoint

chaîne de caractères

OBLIGATOIRE

Chargement...

access_key

chaîne de caractères

Chargement...

secret_key

chaîne de caractères

OBLIGATOIRE

Chargement...

bucket

chaîne de caractères

OBLIGATOIRE

Chargement...

object_prefix

chaîne de caractères

Chargement...

file_compression_type

chaîne de caractères

OBLIGATOIRE

Chargement...

aucungzip

file_type

chaîne de caractères

OBLIGATOIRE

Chargement...

.json

max_retry

entier

OBLIGATOIRE

Chargement...

retry_interval_sec

entier

OBLIGATOIRE

Chargement...

use_ssl

booléen

OBLIGATOIRE

Chargement...

Chargement...

storage_account

chaîne de caractères

OBLIGATOIRE

Chargement...

container

chaîne de caractères

OBLIGATOIRE

Chargement...

sas_token

chaîne de caractères

OBLIGATOIRE

Chargement...

blob_prefix

chaîne de caractères

Chargement...

file_compression_type

chaîne de caractères

OBLIGATOIRE

Chargement...

aucungzip

file_type

chaîne de caractères

OBLIGATOIRE

Chargement...

.json

max_retry

entier

OBLIGATOIRE

Chargement...

retry_interval_sec

entier

OBLIGATOIRE

Chargement...

Chargement...

username

chaîne de caractères

OBLIGATOIRE

Chargement...

password

chaîne de caractères

OBLIGATOIRE

Chargement...

host

chaîne de caractères

OBLIGATOIRE

Chargement...

port

entier

OBLIGATOIRE

Chargement...

sslmode

chaîne de caractères

OBLIGATOIRE

Chargement...

requiredisable

table_name

chaîne de caractères

OBLIGATOIRE

Chargement...

max_retry

entier

OBLIGATOIRE

Chargement...

retry_interval_sec

entier

OBLIGATOIRE

Chargement...

extra_destinations

tableau

Chargement...

destination

chaîne de caractères

OBLIGATOIRE

Chargement...

webhooks3azurepostgres

destination_attributes

objet

OBLIGATOIRE

Chargement...

Renvoie

ID

chaîne de caractères

Chargement...

created_at

chaîne de caractères

Chargement...

updated_at

chaîne de caractères

Chargement...

nom

chaîne de caractères

Chargement...

réseau

chaîne de caractères

Chargement...

dataset

chaîne de caractères

Chargement...

region

chaîne de caractères

Chargement...

filter_function

chaîne de caractères

Chargement...

start_range

entier

Chargement...

end_range

entier

Chargement...

dataset_batch_size

entier

Chargement...

destination

chaîne de caractères

Chargement...

fix_block_reorgs

entier

Chargement...

keep_distance_from_tip

entier

Chargement...

destination_attributes

objet

Chargement...

Chargement...

url

chaîne de caractères

Chargement...

compression

chaîne de caractères

Chargement...

headers

objet

Chargement...

key-value

chaîne de caractères

Chargement...

max_retry

entier

Chargement...

retry_interval_sec

entier

Chargement...

post_timeout_sec

entier

Chargement...

jeton_de_sécurité

chaîne de caractères

Chargement...

Chargement...

endpoint

chaîne de caractères

Chargement...

access_key

chaîne de caractères

Chargement...

secret_key

chaîne de caractères

Chargement...

bucket

chaîne de caractères

Chargement...

object_prefix

chaîne de caractères

Chargement...

file_compression_type

chaîne de caractères

Chargement...

file_type

chaîne de caractères

Chargement...

max_retry

entier

Chargement...

retry_interval_sec

entier

Chargement...

use_ssl

booléen

Chargement...

Chargement...

storage_account

chaîne de caractères

Chargement...

container

chaîne de caractères

Chargement...

sas_token

chaîne de caractères

Chargement...

blob_prefix

chaîne de caractères

Chargement...

file_compression_type

chaîne de caractères

Chargement...

file_type

chaîne de caractères

Chargement...

max_retry

entier

Chargement...

retry_interval_sec

entier

Chargement...

Chargement...

username

chaîne de caractères

Chargement...

password

chaîne de caractères

Chargement...

host

chaîne de caractères

Chargement...

port

entier

Chargement...

sslmode

chaîne de caractères

Chargement...

table_name

chaîne de caractères

Chargement...

max_retry

entier

Chargement...

retry_interval_sec

entier

Chargement...

statut

chaîne de caractères

Chargement...

e-mail_de_notification

chaîne de caractères

Chargement...

sequence

entier

Chargement...

current_hash

chaîne de caractères

Chargement...

elastic_batch_enabled

booléen

Chargement...

extra_destinations

tableau

Chargement...

destination

chaîne de caractères

Chargement...

destination_attributes

objet

Chargement...

Requête

1
curl -X PATCH \
2
    "https://api.quicknode.com/streams/rest/v1/streams/{id}" \
3
    -H "accept: application/json" \
4
    -H "Content-Type: application/json" \
5
    -H "x-api-key: YOUR_API_KEY" \
6
    -d $'{
7
  "filter_function": "ZnVuY3Rpb24gbWFpbihkYXRhKSB7CiAgICB2YXIgbnVtYmVyRGVjaW1hbCA9IHBhcnNlSW50KGRhdGEuc3RyZWFtRGF0YS5udW1iZXIsIDE2KTsKICAgIHZhciBmaWx0ZXJlZERhdGEgPSB7CiAgICAgICAgaGFzaDogZGF0YS5zdHJlYW1EYXRhLmhhc2gsCiAgICAgICAgbnVtYmVyOiBudW1iZXJEZWNpbWFsCiAgICB9OwogICAgcmV0dXJuIGZpbHRlcmVkRGF0YTsKfQ==",
8
  "start_range": 100,
9
  "end_range": 200,
10
  "dataset_batch_size": 1,
11
  "destination": "webhook",
12
  "fix_block_reorgs": 0,
13
  "keep_distance_from_tip": 0,
14
  "destination_attributes": {
15
    "url": "https://wehook.site",
16
    "compression": "none",
17
    "headers": {
18
      "Content-Type": "Test",
19
      "Authorization": "again"
20
    },
21
    "max_retry": 3,
22
    "retry_interval_sec": 1,
23
    "post_timeout_sec": 10
24
  },
25
  "status": "active"
26
}'
27
    

1
curl -X PATCH \
2
    "https://api.quicknode.com/streams/rest/v1/streams/{id}" \
3
    -H "accept: application/json" \
4
    -H "Content-Type: application/json" \
5
    -H "x-api-key: YOUR_API_KEY" \
6
    -d $'{
7
  "filter_function": "ZnVuY3Rpb24gbWFpbihkYXRhKSB7CiAgICB2YXIgbnVtYmVyRGVjaW1hbCA9IHBhcnNlSW50KGRhdGEuc3RyZWFtRGF0YS5udW1iZXIsIDE2KTsKICAgIHZhciBmaWx0ZXJlZERhdGEgPSB7CiAgICAgICAgaGFzaDogZGF0YS5zdHJlYW1EYXRhLmhhc2gsCiAgICAgICAgbnVtYmVyOiBudW1iZXJEZWNpbWFsCiAgICB9OwogICAgcmV0dXJuIGZpbHRlcmVkRGF0YTsKfQ==",
8
  "start_range": 100,
9
  "end_range": 200,
10
  "dataset_batch_size": 1,
11
  "destination": "webhook",
12
  "fix_block_reorgs": 0,
13
  "keep_distance_from_tip": 0,
14
  "destination_attributes": {
15
    "url": "https://wehook.site",
16
    "compression": "none",
17
    "headers": {
18
      "Content-Type": "Test",
19
      "Authorization": "again"
20
    },
21
    "max_retry": 3,
22
    "retry_interval_sec": 1,
23
    "post_timeout_sec": 10
24
  },
25
  "status": "active"
26
}'
27
    

1
const myHeaders = new Headers()
2
myHeaders.append('accept', 'application/json')
3
myHeaders.append('Content-Type', 'application/json')
4
myHeaders.append('x-api-key', 'YOUR_API_KEY') // Replace with your actual API key
5

6
const requestOptions = {
7
	method: 'PATCH',
8
	headers: myHeaders,
9
	redirect: 'follow',
10
	body: JSON.stringify({
11
		filter_function:
12
			'ZnVuY3Rpb24gbWFpbihkYXRhKSB7CiAgICB2YXIgbnVtYmVyRGVjaW1hbCA9IHBhcnNlSW50KGRhdGEuc3RyZWFtRGF0YS5udW1iZXIsIDE2KTsKICAgIHZhciBmaWx0ZXJlZERhdGEgPSB7CiAgICAgICAgaGFzaDogZGF0YS5zdHJlYW1EYXRhLmhhc2gsCiAgICAgICAgbnVtYmVyOiBudW1iZXJEZWNpbWFsCiAgICB9OwogICAgcmV0dXJuIGZpbHRlcmVkRGF0YTsKfQ==',
13
		start_range: 100,
14
		end_range: 200,
15
		dataset_batch_size: 1,
16
		destination: 'webhook',
17
		fix_block_reorgs: 0,
18
		keep_distance_from_tip: 0,
19
		destination_attributes: {
20
			url: 'https://webhook.site',
21
			compression: 'none',
22
			headers: {
23
				'Content-Type': 'Test',
24
				Authorization: 'again',
25
			},
26
			max_retry: 3,
27
			retry_interval_sec: 1,
28
			post_timeout_sec: 10,
29
		},
30
		status: 'active',
31
	}),
32
}
33

34
fetch('https://api.quicknode.com/streams/rest/v1/streams/{id}', requestOptions)
35
	.then(response => response.text())
36
	.then(result => console.log(result))
37
	.catch(error => console.log('error', error))
38

1
const myHeaders = new Headers()
2
myHeaders.append('accept', 'application/json')
3
myHeaders.append('Content-Type', 'application/json')
4
myHeaders.append('x-api-key', 'YOUR_API_KEY') // Replace with your actual API key
5

6
const requestOptions = {
7
	method: 'PATCH',
8
	headers: myHeaders,
9
	redirect: 'follow',
10
	body: JSON.stringify({
11
		filter_function:
12
			'ZnVuY3Rpb24gbWFpbihkYXRhKSB7CiAgICB2YXIgbnVtYmVyRGVjaW1hbCA9IHBhcnNlSW50KGRhdGEuc3RyZWFtRGF0YS5udW1iZXIsIDE2KTsKICAgIHZhciBmaWx0ZXJlZERhdGEgPSB7CiAgICAgICAgaGFzaDogZGF0YS5zdHJlYW1EYXRhLmhhc2gsCiAgICAgICAgbnVtYmVyOiBudW1iZXJEZWNpbWFsCiAgICB9OwogICAgcmV0dXJuIGZpbHRlcmVkRGF0YTsKfQ==',
13
		start_range: 100,
14
		end_range: 200,
15
		dataset_batch_size: 1,
16
		destination: 'webhook',
17
		fix_block_reorgs: 0,
18
		keep_distance_from_tip: 0,
19
		destination_attributes: {
20
			url: 'https://webhook.site',
21
			compression: 'none',
22
			headers: {
23
				'Content-Type': 'Test',
24
				Authorization: 'again',
25
			},
26
			max_retry: 3,
27
			retry_interval_sec: 1,
28
			post_timeout_sec: 10,
29
		},
30
		status: 'active',
31
	}),
32
}
33

34
fetch('https://api.quicknode.com/streams/rest/v1/streams/{id}', requestOptions)
35
	.then(response => response.text())
36
	.then(result => console.log(result))
37
	.catch(error => console.log('error', error))
38

1
import requests
2

3
url = "https://api.quicknode.com/streams/rest/v1/streams/{id}"
4

5
payload = {
6
    "filter_function": "ZnVuY3Rpb24gbWFpbihkYXRhKSB7CiAgICB2YXIgbnVtYmVyRGVjaW1hbCA9IHBhcnNlSW50KGRhdGEuc3RyZWFtRGF0YS5udW1iZXIsIDE2KTsKICAgIHZhciBmaWx0ZXJlZERhdGEgPSB7CiAgICAgICAgaGFzaDogZGF0YS5zdHJlYW1EYXRhLmhhc2gsCiAgICAgICAgbnVtYmVyOiBudW1iZXJEZWNpbWFsCiAgICB9OwogICAgcmV0dXJuIGZpbHRlcmVkRGF0YTsKfQ==",
7
    "start_range": 100,
8
    "end_range": 200,
9
    "dataset_batch_size": 1,
10
    "destination": "webhook",
11
    "fix_block_reorgs": 0,
12
    "keep_distance_from_tip": 0,
13
    "destination_attributes": {
14
        "url": "https://webhook.site",
15
        "compression": "none",
16
        "headers": {
17
            "Content-Type": "Test",
18
            "Authorization": "again"
19
        },
20
        "max_retry": 3,
21
        "retry_interval_sec": 1,
22
        "post_timeout_sec": 10
23
    },
24
    "status": "active"
25
}
26

27
headers = {
28
    "accept": "application/json",
29
    "Content-Type": "application/json",
30
    "x-api-key": "YOUR_API_KEY"  # Replace with your actual API key
31
}
32

33
response = requests.patch(url, headers=headers, json=payload)
34

35
print(response.text)
36

1
import requests
2

3
url = "https://api.quicknode.com/streams/rest/v1/streams/{id}"
4

5
payload = {
6
    "filter_function": "ZnVuY3Rpb24gbWFpbihkYXRhKSB7CiAgICB2YXIgbnVtYmVyRGVjaW1hbCA9IHBhcnNlSW50KGRhdGEuc3RyZWFtRGF0YS5udW1iZXIsIDE2KTsKICAgIHZhciBmaWx0ZXJlZERhdGEgPSB7CiAgICAgICAgaGFzaDogZGF0YS5zdHJlYW1EYXRhLmhhc2gsCiAgICAgICAgbnVtYmVyOiBudW1iZXJEZWNpbWFsCiAgICB9OwogICAgcmV0dXJuIGZpbHRlcmVkRGF0YTsKfQ==",
7
    "start_range": 100,
8
    "end_range": 200,
9
    "dataset_batch_size": 1,
10
    "destination": "webhook",
11
    "fix_block_reorgs": 0,
12
    "keep_distance_from_tip": 0,
13
    "destination_attributes": {
14
        "url": "https://webhook.site",
15
        "compression": "none",
16
        "headers": {
17
            "Content-Type": "Test",
18
            "Authorization": "again"
19
        },
20
        "max_retry": 3,
21
        "retry_interval_sec": 1,
22
        "post_timeout_sec": 10
23
    },
24
    "status": "active"
25
}
26

27
headers = {
28
    "accept": "application/json",
29
    "Content-Type": "application/json",
30
    "x-api-key": "YOUR_API_KEY"  # Replace with your actual API key
31
}
32

33
response = requests.patch(url, headers=headers, json=payload)
34

35
print(response.text)
36

1
require "uri"
2
require "net/http"
3
require "json"
4

5
# Set up the URL for the request
6
url = URI("https://api.quicknode.com/streams/rest/v1/streams/{id}")
7

8
https = Net::HTTP.new(url.host, url.port)
9
https.use_ssl = true
10

11
request = Net::HTTP::Patch.new(url)
12
request["accept"] = "application/json"
13
request["Content-Type"] = "application/json"
14
request["x-api-key"] = "YOUR_API_KEY"  # Replace with your actual API key
15

16
request.body = {
17
  "filter_function" => "ZnVuY3Rpb24gbWFpbihkYXRhKSB7CiAgICB2YXIgbnVtYmVyRGVjaW1hbCA9IHBhcnNlSW50KGRhdGEuc3RyZWFtRGF0YS5udW1iZXIsIDE2KTsKICAgIHZhciBmaWx0ZXJlZERhdGEgPSB7CiAgICAgICAgaGFzaDogZGF0YS5zdHJlYW1EYXRhLmhhc2gsCiAgICAgICAgbnVtYmVyOiBudW1iZXJEZWNpbWFsCiAgICB9OwogICAgcmV0dXJuIGZpbHRlcmVkRGF0YTsKfQ==",
18
  "start_range" => 100,
19
  "end_range" => 200,
20
  "dataset_batch_size" => 1,
21
  "destination" => "webhook",
22
  "fix_block_reorgs" => 0,
23
  "keep_distance_from_tip" => 0,
24
  "destination_attributes" => {
25
    "url" => "https://webhook.site",
26
    "compression" => "none",
27
    "headers" => {
28
      "Content-Type" => "Test",
29
      "Authorization" => "again"
30
    },
31
    "max_retry" => 3,
32
    "retry_interval_sec" => 1,
33
    "post_timeout_sec" => 10
34
  },
35
  "status" => "active"
36
}.to_json
37

38
response = https.request(request)
39
puts response.body
40

1
require "uri"
2
require "net/http"
3
require "json"
4

5
# Set up the URL for the request
6
url = URI("https://api.quicknode.com/streams/rest/v1/streams/{id}")
7

8
https = Net::HTTP.new(url.host, url.port)
9
https.use_ssl = true
10

11
request = Net::HTTP::Patch.new(url)
12
request["accept"] = "application/json"
13
request["Content-Type"] = "application/json"
14
request["x-api-key"] = "YOUR_API_KEY"  # Replace with your actual API key
15

16
request.body = {
17
  "filter_function" => "ZnVuY3Rpb24gbWFpbihkYXRhKSB7CiAgICB2YXIgbnVtYmVyRGVjaW1hbCA9IHBhcnNlSW50KGRhdGEuc3RyZWFtRGF0YS5udW1iZXIsIDE2KTsKICAgIHZhciBmaWx0ZXJlZERhdGEgPSB7CiAgICAgICAgaGFzaDogZGF0YS5zdHJlYW1EYXRhLmhhc2gsCiAgICAgICAgbnVtYmVyOiBudW1iZXJEZWNpbWFsCiAgICB9OwogICAgcmV0dXJuIGZpbHRlcmVkRGF0YTsKfQ==",
18
  "start_range" => 100,
19
  "end_range" => 200,
20
  "dataset_batch_size" => 1,
21
  "destination" => "webhook",
22
  "fix_block_reorgs" => 0,
23
  "keep_distance_from_tip" => 0,
24
  "destination_attributes" => {
25
    "url" => "https://webhook.site",
26
    "compression" => "none",
27
    "headers" => {
28
      "Content-Type" => "Test",
29
      "Authorization" => "again"
30
    },
31
    "max_retry" => 3,
32
    "retry_interval_sec" => 1,
33
    "post_timeout_sec" => 10
34
  },
35
  "status" => "active"
36
}.to_json
37

38
response = https.request(request)
39
puts response.body
40

1
qn stream update {stream_id} --name renamed --notification-email alice@example.com -o json

1
qn stream update {stream_id} --name renamed --notification-email alice@example.com -o json

1
import { QuicknodeSdk } from "@quicknode/sdk"
2

3
const qn = new QuicknodeSdk({ apiKey: "YOUR_API_KEY" })
4

5
const stream = await qn.streams.updateStream("YOUR_STREAM_ID", {
6
	name: "Updated Stream Name",
7
})
8

9
console.log(stream.id, stream.name)
10

1
import { QuicknodeSdk } from "@quicknode/sdk"
2

3
const qn = new QuicknodeSdk({ apiKey: "YOUR_API_KEY" })
4

5
const stream = await qn.streams.updateStream("YOUR_STREAM_ID", {
6
	name: "Updated Stream Name",
7
})
8

9
console.log(stream.id, stream.name)
10

1
import asyncio
2
from quicknode_sdk import QuicknodeSdk, SdkFullConfig
3

4

5
async def main():
6
    qn = QuicknodeSdk(SdkFullConfig(api_key="YOUR_API_KEY"))
7
    stream = await qn.streams.update_stream(
8
        id="YOUR_STREAM_ID",
9
        name="Updated Stream Name",
10
    )
11
    print(stream.id, stream.name)
12

13

14
asyncio.run(main())
15

1
import asyncio
2
from quicknode_sdk import QuicknodeSdk, SdkFullConfig
3

4

5
async def main():
6
    qn = QuicknodeSdk(SdkFullConfig(api_key="YOUR_API_KEY"))
7
    stream = await qn.streams.update_stream(
8
        id="YOUR_STREAM_ID",
9
        name="Updated Stream Name",
10
    )
11
    print(stream.id, stream.name)
12

13

14
asyncio.run(main())
15

1
require "quicknode_sdk"
2

3
qn = QuicknodeSdk::SDK.from_config(api_key: "YOUR_API_KEY")
4

5
stream = qn.streams.update_stream(
6
  id: "YOUR_STREAM_ID",
7
  name: "Updated Stream Name",
8
)
9

10
puts "#{stream["id"]} #{stream["name"]}"
11

1
require "quicknode_sdk"
2

3
qn = QuicknodeSdk::SDK.from_config(api_key: "YOUR_API_KEY")
4

5
stream = qn.streams.update_stream(
6
  id: "YOUR_STREAM_ID",
7
  name: "Updated Stream Name",
8
)
9

10
puts "#{stream["id"]} #{stream["name"]}"
11

1
use quicknode_sdk::{streams::UpdateStreamParams, QuicknodeSdk, SdkFullConfig};
2

3
#[tokio::main]
4
async fn main() -> Result<(), Box<dyn std::error::Error>> {
5
    let qn = QuicknodeSdk::new(&SdkFullConfig::builder().api_key("YOUR_API_KEY").build())?;
6

7
    let params = UpdateStreamParams {
8
        name: Some("Updated Stream Name".to_string()),
9
        ..Default::default()
10
    };
11
    let stream = qn.streams.update_stream("YOUR_STREAM_ID", &params).await?;
12

13
    println!("{} {}", stream.id, stream.name);
14
    Ok(())
15
}
16

1
use quicknode_sdk::{streams::UpdateStreamParams, QuicknodeSdk, SdkFullConfig};
2

3
#[tokio::main]
4
async fn main() -> Result<(), Box<dyn std::error::Error>> {
5
    let qn = QuicknodeSdk::new(&SdkFullConfig::builder().api_key("YOUR_API_KEY").build())?;
6

7
    let params = UpdateStreamParams {
8
        name: Some("Updated Stream Name".to_string()),
9
        ..Default::default()
10
    };
11
    let stream = qn.streams.update_stream("YOUR_STREAM_ID", &params).await?;
12

13
    println!("{} {}", stream.id, stream.name);
14
    Ok(())
15
}
16

Try in Swagger

Vous n'avez pas encore de compte ?

Créez votre endpoint Quicknode en quelques secondes et commencez à développer

Commencez gratuitement