Please note that this method is only available to Enterprise customers. See our pricing for more information.

Path Parameters

id

string

REQUIRED

The unique identifier of the endpoint

Body Parameters

header_name

string

REQUIRED

The name of the IP custom header

Returns

data

object

Contains the updated IP custom header details

header_name

string

The name of the IP custom header that was set

error

string

Contains error details if the request failed; null if successful

Request

1
curl -X 'PATCH' \
2
  'https://api.quicknode.com/v0/endpoints/{id}/ip_custom_header' \
3
  -H 'accept: */*' \
4
  -H 'x-api-key: YOUR_API_KEY' \
5
  -H 'Content-Type: application/json' \
6
  -d '{
7
  "header_name": "X-Forwarded-For"
8
}'
9

1
curl -X 'PATCH' \
2
  'https://api.quicknode.com/v0/endpoints/{id}/ip_custom_header' \
3
  -H 'accept: */*' \
4
  -H 'x-api-key: YOUR_API_KEY' \
5
  -H 'Content-Type: application/json' \
6
  -d '{
7
  "header_name": "X-Forwarded-For"
8
}'
9

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
  "header_name": "X-Forwarded-For"
8
});
9

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

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

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
  "header_name": "X-Forwarded-For"
8
});
9

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

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

1
import requests
2
import json
3

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

6
payload = json.dumps({
7
   "header_name": "X-Forwarded-For"
8
})
9
headers = {
10
  'accept': '*/*',
11
  'x-api-key': 'YOUR_API_KEY',
12
  'Content-Type': 'application/json',
13
}
14

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

17
print(response.text)
18

1
import requests
2
import json
3

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

6
payload = json.dumps({
7
   "header_name": "X-Forwarded-For"
8
})
9
headers = {
10
  'accept': '*/*',
11
  'x-api-key': 'YOUR_API_KEY',
12
  'Content-Type': 'application/json',
13
}
14

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

17
print(response.text)
18

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

5
url = URI("https://api.quicknode.com/v0/endpoints/{id}/ip_custom_header")
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"] = "*/*"
12
request["x-api-key"] = "YOUR_API_KEY"
13
request["Content-Type"] = "application/json"
14
request.body = JSON.dump({
15
  "header_name": "X-Forwarded-For"
16
})
17

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

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

5
url = URI("https://api.quicknode.com/v0/endpoints/{id}/ip_custom_header")
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"] = "*/*"
12
request["x-api-key"] = "YOUR_API_KEY"
13
request["Content-Type"] = "application/json"
14
request.body = JSON.dump({
15
  "header_name": "X-Forwarded-For"
16
})
17

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

1
qn endpoint security ip-header set {endpoint_id} X-Real-IP -o json

1
qn endpoint security ip-header set {endpoint_id} X-Real-IP -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.createOrUpdateIpCustomHeader("ENDPOINT_ID", { headerName: "X-Forwarded-For" })
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.createOrUpdateIpCustomHeader("ENDPOINT_ID", { headerName: "X-Forwarded-For" })
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.create_or_update_ip_custom_header("ENDPOINT_ID", header_name="X-Forwarded-For")
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.create_or_update_ip_custom_header("ENDPOINT_ID", header_name="X-Forwarded-For")
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.create_or_update_ip_custom_header("ENDPOINT_ID", header_name: "X-Forwarded-For")
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.create_or_update_ip_custom_header("ENDPOINT_ID", header_name: "X-Forwarded-For")
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.create_or_update_ip_custom_header("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.create_or_update_ip_custom_header("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