Path Parameters

id

string

REQUIRED

The unique identifier of the endpoint

Returns

data

object

Contains the security state of the endpoint

options

object

Security feature toggles for the endpoint

tokens

boolean

Whether token-based authentication is enabled

referrers

boolean

Whether referrer-based restrictions are enabled

jwts

boolean

Whether JWT-based authentication is enabled

ips

boolean

Whether IP-based restrictions are enabled

domainMasks

boolean

Whether domain mask restrictions are enabled

hsts

boolean

Whether HSTS is enabled

cors

boolean

Whether CORS is enabled

responseLogging

boolean

Whether response logging is enabled

requestFilters

boolean

Whether request filters are enabled

ipCustomHeader

object

IP custom header configuration

value

string

The IP custom header value; null if not set

tokens

array

An array of authentication token objects; null if none configured

id

string

The unique identifier (UUID) of the token

token

string

The authentication token value

jwts

array

An array of JWT configuration objects; null if none configured

referrers

array

An array of allowed referrer entries; null if none configured

domain_masks

array

An array of domain mask entries; null if none configured

ips

array

An array of allowed IP entries; null if none configured

request_filters

array

An array of request filter objects; null if none configured

id

string

The unique identifier (UUID) of the request filter

method

array

An array of whitelisted method names

params

object

Parameter constraints for the filter

error

string

Contains error details if the request failed; null if successful

Request

1
curl -X 'GET' \
2
  'https://api.quicknode.com/v0/endpoints/{id}/security' \
3
  -H 'accept: application/json' \
4
  -H 'x-api-key: YOUR_API_KEY'
5

1
curl -X 'GET' \
2
  'https://api.quicknode.com/v0/endpoints/{id}/security' \
3
  -H 'accept: application/json' \
4
  -H 'x-api-key: YOUR_API_KEY'
5

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

5
const requestOptions = {
6
  method: "GET",
7
  headers: myHeaders,
8
  redirect: "follow"
9
};
10

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

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

5
const requestOptions = {
6
  method: "GET",
7
  headers: myHeaders,
8
  redirect: "follow"
9
};
10

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

1
import requests
2

3
url = "https://api.quicknode.com/v0/endpoints/{id}/security"
4

5
headers = {
6
  'accept': 'application/json',
7
  'x-api-key': 'YOUR_API_KEY',
8
}
9

10
response = requests.request("GET", url, headers=headers)
11

12
print(response.text)
13

1
import requests
2

3
url = "https://api.quicknode.com/v0/endpoints/{id}/security"
4

5
headers = {
6
  'accept': 'application/json',
7
  'x-api-key': 'YOUR_API_KEY',
8
}
9

10
response = requests.request("GET", url, headers=headers)
11

12
print(response.text)
13

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

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

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

9
request = Net::HTTP::Get.new(url)
10
request["accept"] = "application/json"
11
request["x-api-key"] = "YOUR_API_KEY"
12

13
response = https.request(request)
14
puts response.read_body
15

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

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

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

9
request = Net::HTTP::Get.new(url)
10
request["accept"] = "application/json"
11
request["x-api-key"] = "YOUR_API_KEY"
12

13
response = https.request(request)
14
puts response.read_body
15

1
qn endpoint security show {endpoint_id} -o json

1
qn endpoint security show {endpoint_id} -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.getEndpointSecurity("ENDPOINT_ID")
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.getEndpointSecurity("ENDPOINT_ID")
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.get_endpoint_security("ENDPOINT_ID")
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.get_endpoint_security("ENDPOINT_ID")
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.get_endpoint_security("ENDPOINT_ID")
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.get_endpoint_security("ENDPOINT_ID")
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.get_endpoint_security("ENDPOINT_ID").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.get_endpoint_security("ENDPOINT_ID").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