v0/endpoints/{id}/status REST API Endpoint

Path Parameters

id

string

REQUIRED

The unique identifier of the endpoint to be updated

Body Parameters

status

string

REQUIRED

The new status to apply to the endpoint. Accepted values are 'active' and 'paused'

Returns

data

string

The updated status of the endpoint (either 'active' or 'paused')

error

string

Contains error details if the request failed; null if successful

Request

curl -X 'PATCH' \
  'https://api.quicknode.com/v0/endpoints/{id}/status' \
  -H 'accept: */*' \
  -H 'x-api-key: YOUR_API_KEY' \
  -H 'Content-Type: application/json' \
  -d '{
  "status": "paused"
}'

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

const raw = JSON.stringify({
  "status": "paused"
});

const requestOptions = {
  method: "PATCH",
  headers: myHeaders,
  body: raw,
  redirect: "follow"
};

fetch("https://api.quicknode.com/v0/endpoints/{id}/status", requestOptions)
  .then((response) => response.text())
  .then((result) => console.log(result))
  .catch((error) => console.error(error));

import requests
import json

url = "https://api.quicknode.com/v0/endpoints/{id}/status"

payload = json.dumps({
   "status": "paused"
})
headers = {
  'accept': '*/*',
  'x-api-key': 'YOUR_API_KEY',
  'Content-Type': 'application/json',
}

response = requests.request("PATCH", url, headers=headers, data=payload)

print(response.text)

require "uri"
require "json"
require "net/http"

url = URI("https://api.quicknode.com/v0/endpoints/{id}/status")

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

request = Net::HTTP::Patch.new(url)
request["accept"] = "*/*"
request["x-api-key"] = "YOUR_API_KEY"
request["Content-Type"] = "application/json"
request.body = JSON.dump({
  "status": "paused"
})

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

Don't have an account yet?

Create your QuickNode endpoint in seconds and start building

Get started for free