Path Parameters

id

string

REQUIRED

The unique identifier for the specific endpoint

Body Parameters

options

object

The options object which contains the following fields:

tokens

string

Controls the token-based authentication mechanism. Possible values includes 'enabled' or 'disabled'

referrers

string

The URL or domain that is allowed to access the specific API endpoint. Possible values includes 'enabled' or 'disabled'

jwts

string

Configures JSON Web Tokens (JWTs) for secure authentication and authorization. Possible values includes 'enabled' or 'disabled'

ips

string

Specifies IP address-based restrictions or permissions. Possible values includes 'enabled' or 'disabled'

domainMasks

string

Configures the masking or restriction of specific domains. Possible values includes 'enabled' or 'disabled'

hsts

string

The HTTP Strict Transport Security (HSTS). Possible values includes 'enabled' or 'disabled'

cors

string

Configures Cross-Origin Resource Sharing (CORS) policies to control how resources can be accessed by external domains. Possible values includes 'enabled' or 'disabled'

Returns

data

object

The data object which contains the following fields:

option

string

Represents the security options

status

string

Indicates the status of the option. Possible values: enabled, disabled

error

string

A field containing an error message if any issue occurs

Request

1
curl -X 'PATCH' 'https://api.quicknode.com/v0/endpoints/{id}/security_options' \
2
--header 'accept: application/json' \
3
--header 'x-api-key: YOUR_API_KEY' \
4
--header 'Content-Type: application/json' \
5
--data '{
6
  "options": {
7
    "tokens": "enabled",
8
    "referrers": "enabled",
9
    "jwts": "enabled",
10
    "ips": "enabled",
11
    "domainMasks": "enabled",
12
    "hsts": "enabled",
13
    "cors": "enabled"
14
  }
15
}'
16

1
curl -X 'PATCH' 'https://api.quicknode.com/v0/endpoints/{id}/security_options' \
2
--header 'accept: application/json' \
3
--header 'x-api-key: YOUR_API_KEY' \
4
--header 'Content-Type: application/json' \
5
--data '{
6
  "options": {
7
    "tokens": "enabled",
8
    "referrers": "enabled",
9
    "jwts": "enabled",
10
    "ips": "enabled",
11
    "domainMasks": "enabled",
12
    "hsts": "enabled",
13
    "cors": "enabled"
14
  }
15
}'
16

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

6
const raw = JSON.stringify({
7
  "options": {
8
    "tokens": "enabled",
9
    "referrers": "enabled",
10
    "jwts": "enabled",
11
    "ips": "enabled",
12
    "domainMasks": "enabled",
13
    "hsts": "enabled",
14
    "cors": "enabled"
15
  }
16
});
17

18
const requestOptions = {
19
  method: "PATCH",
20
  headers: myHeaders,
21
  body: raw,
22
  redirect: "follow"
23
};
24

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

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

6
const raw = JSON.stringify({
7
  "options": {
8
    "tokens": "enabled",
9
    "referrers": "enabled",
10
    "jwts": "enabled",
11
    "ips": "enabled",
12
    "domainMasks": "enabled",
13
    "hsts": "enabled",
14
    "cors": "enabled"
15
  }
16
});
17

18
const requestOptions = {
19
  method: "PATCH",
20
  headers: myHeaders,
21
  body: raw,
22
  redirect: "follow"
23
};
24

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

1
import requests
2
import json
3

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

6
payload = json.dumps({
7
  "options": {
8
    "tokens": "enabled",
9
    "referrers": "enabled",
10
    "jwts": "enabled",
11
    "ips": "enabled",
12
    "domainMasks": "enabled",
13
    "hsts": "enabled",
14
    "cors": "enabled"
15
  }
16
})
17
headers = {
18
  'accept': 'application/json',
19
  'x-api-key': 'YOUR_API_KEY',
20
  'Content-Type': 'application/json'
21
}
22

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

25
print(response.text)
26

1
import requests
2
import json
3

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

6
payload = json.dumps({
7
  "options": {
8
    "tokens": "enabled",
9
    "referrers": "enabled",
10
    "jwts": "enabled",
11
    "ips": "enabled",
12
    "domainMasks": "enabled",
13
    "hsts": "enabled",
14
    "cors": "enabled"
15
  }
16
})
17
headers = {
18
  'accept': 'application/json',
19
  'x-api-key': 'YOUR_API_KEY',
20
  'Content-Type': 'application/json'
21
}
22

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

25
print(response.text)
26

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

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

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

10
request = Net::HTTP::Patch.new(url)
11
request["accept"] = "application/json"
12
request["x-api-key"] = "YOUR_API_KEY"
13
request["Content-Type"] = "application/json"
14
request.body = JSON.dump({
15
  "options": {
16
    "tokens": "enabled",
17
    "referrers": "enabled",
18
    "jwts": "enabled",
19
    "ips": "enabled",
20
    "domainMasks": "enabled",
21
    "hsts": "enabled",
22
    "cors": "enabled"
23
  }
24
})
25

26
response = https.request(request)
27
puts response.read_body
28

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

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

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

10
request = Net::HTTP::Patch.new(url)
11
request["accept"] = "application/json"
12
request["x-api-key"] = "YOUR_API_KEY"
13
request["Content-Type"] = "application/json"
14
request.body = JSON.dump({
15
  "options": {
16
    "tokens": "enabled",
17
    "referrers": "enabled",
18
    "jwts": "enabled",
19
    "ips": "enabled",
20
    "domainMasks": "enabled",
21
    "hsts": "enabled",
22
    "cors": "enabled"
23
  }
24
})
25

26
response = https.request(request)
27
puts response.read_body
28

1
qn endpoint security set-options {endpoint_id} --tokens enabled --cors disabled -o json

1
qn endpoint security set-options {endpoint_id} --tokens enabled --cors disabled -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.updateSecurityOptions("ENDPOINT_ID", { options: { tokens: "enabled" } })
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.updateSecurityOptions("ENDPOINT_ID", { options: { tokens: "enabled" } })
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.update_security_options("ENDPOINT_ID", tokens="enabled")
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.update_security_options("ENDPOINT_ID", tokens="enabled")
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.update_security_options("ENDPOINT_ID", tokens: "enabled")
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.update_security_options("ENDPOINT_ID", tokens: "enabled")
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.update_security_options("ENDPOINT_ID", &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.update_security_options("ENDPOINT_ID", &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