Body Parameters

ids

array

REQUIRED

An array of endpoint IDs to update

status

string

REQUIRED

The status to apply. Accepted values: active, paused

Returns

data

object

Contains the result of the bulk status update

total

integer

The total number of endpoints in the request

updated_count

integer

The number of endpoints successfully updated

failed_count

integer

The number of endpoints that failed to update

results

array

An array of result objects for each endpoint

id

string

The endpoint ID

success

boolean

Whether the status update succeeded for this endpoint

Request

1
curl -X 'POST' \
2
  'https://api.quicknode.com/v0/endpoints/bulk/status' \
3
  -H 'accept: */*' \
4
  -H 'x-api-key: YOUR_API_KEY' \
5
  -H 'Content-Type: application/json' \
6
  -d '{
7
  "ids": ["endpoint_id_1", "endpoint_id_2"],
8
  "status": "paused"
9
}'
10

1
curl -X 'POST' \
2
  'https://api.quicknode.com/v0/endpoints/bulk/status' \
3
  -H 'accept: */*' \
4
  -H 'x-api-key: YOUR_API_KEY' \
5
  -H 'Content-Type: application/json' \
6
  -d '{
7
  "ids": ["endpoint_id_1", "endpoint_id_2"],
8
  "status": "paused"
9
}'
10

1
const myHeaders = new Headers();
2
myHeaders.append("accept", "*/*");
3
myHeaders.append("x-api-key", "YOUR_API_KEY");
4
myHeaders.append("Content-Type", "application/json");
5

6
const raw = JSON.stringify({
7
  "ids": ["endpoint_id_1", "endpoint_id_2"],
8
  "status": "paused"
9
});
10

11
const requestOptions = {
12
  method: "POST",
13
  headers: myHeaders,
14
  body: raw,
15
  redirect: "follow"
16
};
17

18
fetch("https://api.quicknode.com/v0/endpoints/bulk/status", requestOptions)
19
  .then((response) => response.text())
20
  .then((result) => console.log(result))
21
  .catch((error) => console.error(error));
22

1
const myHeaders = new Headers();
2
myHeaders.append("accept", "*/*");
3
myHeaders.append("x-api-key", "YOUR_API_KEY");
4
myHeaders.append("Content-Type", "application/json");
5

6
const raw = JSON.stringify({
7
  "ids": ["endpoint_id_1", "endpoint_id_2"],
8
  "status": "paused"
9
});
10

11
const requestOptions = {
12
  method: "POST",
13
  headers: myHeaders,
14
  body: raw,
15
  redirect: "follow"
16
};
17

18
fetch("https://api.quicknode.com/v0/endpoints/bulk/status", requestOptions)
19
  .then((response) => response.text())
20
  .then((result) => console.log(result))
21
  .catch((error) => console.error(error));
22

1
import requests
2
import json
3

4
url = "https://api.quicknode.com/v0/endpoints/bulk/status"
5

6
payload = json.dumps({
7
   "ids": ["endpoint_id_1", "endpoint_id_2"],
8
   "status": "paused"
9
})
10
headers = {
11
  'accept': '*/*',
12
  'x-api-key': 'YOUR_API_KEY',
13
  'Content-Type': 'application/json',
14
}
15

16
response = requests.request("POST", url, headers=headers, data=payload)
17

18
print(response.text)
19

1
import requests
2
import json
3

4
url = "https://api.quicknode.com/v0/endpoints/bulk/status"
5

6
payload = json.dumps({
7
   "ids": ["endpoint_id_1", "endpoint_id_2"],
8
   "status": "paused"
9
})
10
headers = {
11
  'accept': '*/*',
12
  'x-api-key': 'YOUR_API_KEY',
13
  'Content-Type': 'application/json',
14
}
15

16
response = requests.request("POST", url, headers=headers, data=payload)
17

18
print(response.text)
19

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

5
url = URI("https://api.quicknode.com/v0/endpoints/bulk/status")
6

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

10
request = Net::HTTP::Post.new(url)
11
request["accept"] = "*/*"
12
request["x-api-key"] = "YOUR_API_KEY"
13
request["Content-Type"] = "application/json"
14
request.body = JSON.dump({
15
  "ids": ["endpoint_id_1", "endpoint_id_2"],
16
  "status": "paused"
17
})
18

19
response = https.request(request)
20
puts response.read_body
21

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

5
url = URI("https://api.quicknode.com/v0/endpoints/bulk/status")
6

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

10
request = Net::HTTP::Post.new(url)
11
request["accept"] = "*/*"
12
request["x-api-key"] = "YOUR_API_KEY"
13
request["Content-Type"] = "application/json"
14
request.body = JSON.dump({
15
  "ids": ["endpoint_id_1", "endpoint_id_2"],
16
  "status": "paused"
17
})
18

19
response = https.request(request)
20
puts response.read_body
21

1
qn endpoint bulk pause {endpoint_id_1} {endpoint_id_2} {endpoint_id_3} -o json

1
qn endpoint bulk pause {endpoint_id_1} {endpoint_id_2} {endpoint_id_3} -o json

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

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

5
const response = await qn.admin.bulkUpdateEndpointStatus({ ids: ["ENDPOINT_ID"], status: "paused" })
6
console.log(response)
7

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

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

5
const response = await qn.admin.bulkUpdateEndpointStatus({ ids: ["ENDPOINT_ID"], status: "paused" })
6
console.log(response)
7

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
    response = await qn.admin.bulk_update_endpoint_status(ids=["ENDPOINT_ID"], status="paused")
8
    print(response)
9

10

11
asyncio.run(main())
12

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
    response = await qn.admin.bulk_update_endpoint_status(ids=["ENDPOINT_ID"], status="paused")
8
    print(response)
9

10

11
asyncio.run(main())
12

1
require "quicknode_sdk"
2

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

5
response = qn.admin.bulk_update_endpoint_status(ids: ["ENDPOINT_ID"], status: "paused")
6
puts response
7

1
require "quicknode_sdk"
2

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

5
response = qn.admin.bulk_update_endpoint_status(ids: ["ENDPOINT_ID"], status: "paused")
6
puts response
7

1
use quicknode_sdk::{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
    let response = qn.admin.bulk_update_endpoint_status(&Default::default()).await?;
7

8
    println!("{:?}", response);
9
    Ok(())
10
}
11

1
use quicknode_sdk::{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
    let response = qn.admin.bulk_update_endpoint_status(&Default::default()).await?;
7

8
    println!("{:?}", response);
9
    Ok(())
10
}
11

Don't have an account yet?

Create your Quicknode endpoint in seconds and start building

Get started for free