Skip to main content

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

Updates security options for an endpoint.

Updated on
Oct 29, 2024

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

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
error
string
A field containing an error message if any issue occurs
Request
1
curl 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
}'
Don't have an account yet?
Create your QuickNode endpoint in seconds and start building
Get started for free