Path Parameters

id

string

REQUIRED

The unique identifier for the specific endpoint

Body Parameters

ip

string

REQUIRED

The specific IP address that is allowed to access the API endpoint. Only requests originating from this IP address will be permitted

Returns

data

object

The data object which contains the following fields:

id

string

A unique identifier for the IP rule

ip

string

The IP address that is allowed to access the API endpoint

error

string

A field containing an error message if any issue occurs

Request

1
curl -X 'POST' \
2
  'https://api.quicknode.com/v0/endpoints/{id}/security/ips' \
3
  -H 'accept: */*' \
4
  -H 'x-api-key: YOUR_API_KEY' \
5
  -H 'Content-Type: application/json' \
6
  -d '{
7
  "ip": "{YOUR_IP_ADDRESS}"
8
}'

1
curl -X 'POST' \
2
  'https://api.quicknode.com/v0/endpoints/{id}/security/ips' \
3
  -H 'accept: */*' \
4
  -H 'x-api-key: YOUR_API_KEY' \
5
  -H 'Content-Type: application/json' \
6
  -d '{
7
  "ip": "{YOUR_IP_ADDRESS}"
8
}'

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
  "ip": "{YOUR_IP_ADDRESS}"
8
});
9

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

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

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
  "ip": "{YOUR_IP_ADDRESS}"
8
});
9

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

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

1
import requests
2
import json
3

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

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

15
response = requests.request("POST", 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}/security/ips"
5

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

15
response = requests.request("POST", 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}/security/ips")
6

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

10
request = Net::HTTP::Post.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
  "ip": "{YOUR_IP_ADDRESS}"
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}/security/ips")
6

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

10
request = Net::HTTP::Post.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
  "ip": "{YOUR_IP_ADDRESS}"
16
})
17

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

1
qn endpoint security ip add {endpoint_id} 203.0.113.7 -o json

1
qn endpoint security ip add {endpoint_id} 203.0.113.7 -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.createIp("ENDPOINT_ID", { ip: "203.0.113.10" })
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.createIp("ENDPOINT_ID", { ip: "203.0.113.10" })
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_ip("ENDPOINT_ID", ip="203.0.113.10")
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_ip("ENDPOINT_ID", ip="203.0.113.10")
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_ip("ENDPOINT_ID", ip: "203.0.113.10")
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_ip("ENDPOINT_ID", ip: "203.0.113.10")
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_ip("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_ip("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