PATCH /streams/rest/v1/streams REST API Endpoint

Path Parameters

string

REQUIRED

Body Parameters

name

string

REQUIRED

filter_function

string

region

string

start_range

integer

end_range

integer

dataset_batch_size

integer

REQUIRED

include_stream_metadata

string

REQUIRED

status

string

REQUIRED

elastic_batch_enabled

boolean

fix_block_reorgs

integer

keep_distance_from_tip

integer

notification_email

string

destination

string

REQUIRED

destination_attributes

object

url

string

REQUIRED

compression

string

REQUIRED

headers

object

key-value

string

max_retry

integer

REQUIRED

retry_interval_sec

integer

REQUIRED

post_timeout_sec

integer

REQUIRED

destination_attributes

object

endpoint

string

REQUIRED

access_key

string

secret_key

string

REQUIRED

bucket

string

REQUIRED

object_prefix

string

file_compression_type

string

REQUIRED

file_type

string

REQUIRED

max_retry

integer

REQUIRED

retry_interval_sec

integer

REQUIRED

use_ssl

boolean

REQUIRED

destination_attributes

object

storage_account

string

REQUIRED

container

string

REQUIRED

sas_token

string

REQUIRED

blob_prefix

string

file_compression_type

string

REQUIRED

file_type

string

REQUIRED

max_retry

integer

REQUIRED

retry_interval_sec

integer

REQUIRED

destination_attributes

object

username

string

REQUIRED

password

string

REQUIRED

host

string

REQUIRED

port

integer

REQUIRED

sslmode

string

REQUIRED

table_name

string

REQUIRED

max_retry

integer

REQUIRED

retry_interval_sec

integer

REQUIRED

Returns

string

created_at

string

updated_at

string

name

string

network

string

dataset

string

region

string

filter_function

string

start_range

integer

end_range

integer

dataset_batch_size

integer

include_stream_metadata

string

destination

string

fix_block_reorgs

integer

keep_distance_from_tip

integer

destination_attributes

object

url

string

compression

string

headers

object

key-value

string

max_retry

integer

retry_interval_sec

integer

post_timeout_sec

integer

security_token

string

destination_attributes

object

endpoint

string

access_key

string

secret_key

string

bucket

string

object_prefix

string

file_compression_type

string

file_type

string

max_retry

integer

retry_interval_sec

integer

use_ssl

boolean

destination_attributes

object

storage_account

string

container

string

sas_token

string

blob_prefix

string

file_compression_type

string

file_type

string

max_retry

integer

retry_interval_sec

integer

destination_attributes

object

username

string

password

string

host

string

port

integer

sslmode

string

table_name

string

max_retry

integer

retry_interval_sec

integer

status

string

notification_email

string

sequence

integer

current_hash

string

Request

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
  "include_stream_metadata": "body",
12
  "destination": "webhook",
13
  "fix_block_reorgs": 0,
14
  "keep_distance_from_tip": 0,
15
  "destination_attributes": {
16
    "url": "https://wehook.site",
17
    "compression": "none",
18
    "headers": {
19
      "Content-Type": "Test",
20
      "Authorization": "again"
21
    },
22
    "max_retry": 3,
23
    "retry_interval_sec": 1,
24
    "post_timeout_sec": 10
25
  },
26
  "status": "active"
27
}'
28

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
  "include_stream_metadata": "body",
12
  "destination": "webhook",
13
  "fix_block_reorgs": 0,
14
  "keep_distance_from_tip": 0,
15
  "destination_attributes": {
16
    "url": "https://wehook.site",
17
    "compression": "none",
18
    "headers": {
19
      "Content-Type": "Test",
20
      "Authorization": "again"
21
    },
22
    "max_retry": 3,
23
    "retry_interval_sec": 1,
24
    "post_timeout_sec": 10
25
  },
26
  "status": "active"
27
}'
28

1
var 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
var requestOptions = {
7
  method: 'PATCH',
8
  headers: myHeaders,
9
  redirect: 'follow',
10
  body: JSON.stringify({
11
    filter_function: 'ZnVuY3Rpb24gbWFpbihkYXRhKSB7CiAgICB2YXIgbnVtYmVyRGVjaW1hbCA9IHBhcnNlSW50KGRhdGEuc3RyZWFtRGF0YS5udW1iZXIsIDE2KTsKICAgIHZhciBmaWx0ZXJlZERhdGEgPSB7CiAgICAgICAgaGFzaDogZGF0YS5zdHJlYW1EYXRhLmhhc2gsCiAgICAgICAgbnVtYmVyOiBudW1iZXJEZWNpbWFsCiAgICB9OwogICAgcmV0dXJuIGZpbHRlcmVkRGF0YTsKfQ==',
12
    start_range: 100,
13
    end_range: 200,
14
    dataset_batch_size: 1,
15
    include_stream_metadata: 'body',
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
var 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
var requestOptions = {
7
  method: 'PATCH',
8
  headers: myHeaders,
9
  redirect: 'follow',
10
  body: JSON.stringify({
11
    filter_function: 'ZnVuY3Rpb24gbWFpbihkYXRhKSB7CiAgICB2YXIgbnVtYmVyRGVjaW1hbCA9IHBhcnNlSW50KGRhdGEuc3RyZWFtRGF0YS5udW1iZXIsIDE2KTsKICAgIHZhciBmaWx0ZXJlZERhdGEgPSB7CiAgICAgICAgaGFzaDogZGF0YS5zdHJlYW1EYXRhLmhhc2gsCiAgICAgICAgbnVtYmVyOiBudW1iZXJEZWNpbWFsCiAgICB9OwogICAgcmV0dXJuIGZpbHRlcmVkRGF0YTsKfQ==',
12
    start_range: 100,
13
    end_range: 200,
14
    dataset_batch_size: 1,
15
    include_stream_metadata: 'body',
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
    "include_stream_metadata": "body",
11
    "destination": "webhook",
12
    "fix_block_reorgs": 0,
13
    "keep_distance_from_tip": 0,
14
    "destination_attributes": {
15
        "url": "https://webhook.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

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

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

36
print(response.text)
37

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
    "include_stream_metadata": "body",
11
    "destination": "webhook",
12
    "fix_block_reorgs": 0,
13
    "keep_distance_from_tip": 0,
14
    "destination_attributes": {
15
        "url": "https://webhook.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

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

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

36
print(response.text)
37

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
  "include_stream_metadata" => "body",
22
  "destination" => "webhook",
23
  "fix_block_reorgs" => 0,
24
  "keep_distance_from_tip" => 0,
25
  "destination_attributes" => {
26
    "url" => "https://webhook.site",
27
    "compression" => "none",
28
    "headers" => {
29
      "Content-Type" => "Test",
30
      "Authorization" => "again"
31
    },
32
    "max_retry" => 3,
33
    "retry_interval_sec" => 1,
34
    "post_timeout_sec" => 10
35
  },
36
  "status" => "active"
37
}.to_json
38

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

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
  "include_stream_metadata" => "body",
22
  "destination" => "webhook",
23
  "fix_block_reorgs" => 0,
24
  "keep_distance_from_tip" => 0,
25
  "destination_attributes" => {
26
    "url" => "https://webhook.site",
27
    "compression" => "none",
28
    "headers" => {
29
      "Content-Type" => "Test",
30
      "Authorization" => "again"
31
    },
32
    "max_retry" => 3,
33
    "retry_interval_sec" => 1,
34
    "post_timeout_sec" => 10
35
  },
36
  "status" => "active"
37
}.to_json
38

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

Try in Swagger

Don't have an account yet?

Create your Quicknode endpoint in seconds and start building

Get started for free

PATCH /streams/rest/v1/streams REST API Endpoint

Loading...

Path Parameters

Body Parameters

Returns