จุดเชื่อมต่อในหน้านี้
GET /v1/api-keys: แสดงรายการ API keysPOST /v1/api-keys: สร้าง API keyDELETE /v1/api-keys/{keyId}: เพิกถอน API keyGET /v1/ip-whitelist: แสดงรายการ IP ที่อนุญาตPOST /v1/ip-whitelist: เพิ่ม IP หรือช่วง IP ในรายการที่อนุญาตDELETE /v1/ip-whitelist/{entryId}: ลบรายการออกจากรายการ IP ที่อนุญาต
URL ฐาน https://localserpproxy.com/api/v1 ดูข้อมูลการยืนยันตัวตน ข้อผิดพลาด และขีดจำกัดได้ที่ ภาพรวม API
แสดงรายการ API keys
GET/v1/api-keys
การยืนยันตัวตน: ใช้คีย์ API ในส่วนหัว Authorization: Bearer API_KEY
การตอบกลับ 200 OK
{
"data": [
{
"id": "key_5n2v8q",
"name": "Rotation script",
"prefix": "pk_4f9a2c",
"scopes": [
"read",
"proxies"
],
"createdAt": "2026-10-05T14:03:11Z",
"lastUsedAt": null
}
],
"limit": 20
}ตัวอย่างโค้ด
curl -s "https://localserpproxy.com/api/v1/api-keys" \
-H "Authorization: Bearer $API_KEY"import os
import requests
API = "https://localserpproxy.com/api/v1"
HEADERS = {"Authorization": f"Bearer {os.environ['API_KEY']}"}
r = requests.get(f"{API}/api-keys", headers=HEADERS, timeout=30)
r.raise_for_status()
print(r.json())// Node.js 18+ (built-in fetch), ES module
const API = 'https://localserpproxy.com/api/v1';
const res = await fetch(`${API}/api-keys`, {
headers: { Authorization: `Bearer ${process.env.API_KEY}` },
});
if (!res.ok) throw new Error((await res.json()).error?.message ?? `HTTP ${res.status}`);
console.log(await res.json());สร้าง API key
POST/v1/api-keys
คืนเงินเต็มจำนวน secret เพียงครั้งเดียว
การยืนยันตัวตน: ใช้คีย์ API ในส่วนหัว Authorization: Bearer API_KEY
เนื้อหาคำขอ
| ฟิลด์ | ประเภท | จำเป็น | คำอธิบาย |
|---|---|---|---|
name | string | ใช่ | สูงสุด 60 ตัวอักษร |
scopes | array of read · proxies · billing | ใช่ | — |
{
"name": "Rotation script",
"scopes": [
"read",
"proxies"
]
}การตอบกลับ 201 Created
{
"id": "key_5n2v8q",
"name": "Rotation script",
"prefix": "pk_4f9a2c",
"scopes": [
"read",
"proxies"
],
"createdAt": "2026-10-05T14:03:11Z",
"lastUsedAt": null,
"secret": "pk_4f9a2c8e1b7d3f6a9c2e5b8d1f4a7c0e"
}ตัวอย่างโค้ด
curl -s -X POST "https://localserpproxy.com/api/v1/api-keys" \
-H "Authorization: Bearer $API_KEY" \
-H "Content-Type: application/json" \
-d '{"name":"Rotation script","scopes":["read","proxies"]}'import os
import requests
API = "https://localserpproxy.com/api/v1"
HEADERS = {"Authorization": f"Bearer {os.environ['API_KEY']}"}
r = requests.post(f"{API}/api-keys", headers=HEADERS, json={"name": "Rotation script", "scopes": ["read", "proxies"]}, timeout=30)
r.raise_for_status()
print(r.json())// Node.js 18+ (built-in fetch), ES module
const API = 'https://localserpproxy.com/api/v1';
const res = await fetch(`${API}/api-keys`, {
method: 'POST',
headers: { Authorization: `Bearer ${process.env.API_KEY}`, 'Content-Type': 'application/json' },
body: JSON.stringify({ name: 'Rotation script', scopes: ['read', 'proxies'] }),
});
if (!res.ok) throw new Error((await res.json()).error?.message ?? `HTTP ${res.status}`);
console.log(await res.json());เพิกถอน API key
DELETE/v1/api-keys/{keyId}
การยืนยันตัวตน: ใช้คีย์ API ในส่วนหัว Authorization: Bearer API_KEY
พารามิเตอร์
| ชื่อ | ใน | ประเภท | จำเป็น | คำอธิบาย |
|---|---|---|---|---|
keyId | path | string | ใช่ | — |
การตอบกลับ 204 No Content
ไม่มีเนื้อหาคำขอ: ใช้รหัสสถานะเป็นคำตอบ
ตัวอย่างโค้ด
curl -s -X DELETE "https://localserpproxy.com/api/v1/api-keys/key_5n2v8q" \
-H "Authorization: Bearer $API_KEY"import os
import requests
API = "https://localserpproxy.com/api/v1"
HEADERS = {"Authorization": f"Bearer {os.environ['API_KEY']}"}
r = requests.delete(f"{API}/api-keys/key_5n2v8q", headers=HEADERS, timeout=30)
r.raise_for_status()
print(r.status_code) # 204: done// Node.js 18+ (built-in fetch), ES module
const API = 'https://localserpproxy.com/api/v1';
const res = await fetch(`${API}/api-keys/key_5n2v8q`, {
method: 'DELETE',
headers: { Authorization: `Bearer ${process.env.API_KEY}` },
});
if (!res.ok) throw new Error(`HTTP ${res.status}`);
console.log(res.status); // 204: doneแสดงรายการ IP ที่อนุญาต
GET/v1/ip-whitelist
การยืนยันตัวตน: ใช้คีย์ API ในส่วนหัว Authorization: Bearer API_KEY
การตอบกลับ 200 OK
{
"data": [
{
"id": "ipw_8c1k2m",
"cidr": "203.0.113.24",
"label": "Office server",
"createdAt": "2026-10-05T14:03:11Z"
}
],
"limit": 10
}ตัวอย่างโค้ด
curl -s "https://localserpproxy.com/api/v1/ip-whitelist" \
-H "Authorization: Bearer $API_KEY"import os
import requests
API = "https://localserpproxy.com/api/v1"
HEADERS = {"Authorization": f"Bearer {os.environ['API_KEY']}"}
r = requests.get(f"{API}/ip-whitelist", headers=HEADERS, timeout=30)
r.raise_for_status()
print(r.json())// Node.js 18+ (built-in fetch), ES module
const API = 'https://localserpproxy.com/api/v1';
const res = await fetch(`${API}/ip-whitelist`, {
headers: { Authorization: `Bearer ${process.env.API_KEY}` },
});
if (!res.ok) throw new Error((await res.json()).error?.message ?? `HTTP ${res.status}`);
console.log(await res.json());เพิ่ม IP หรือช่วง IP ในรายการที่อนุญาต
POST/v1/ip-whitelist
รองรับที่อยู่ IPv4, IPv4 CIDR ตั้งแต่ /24 ถึง /32, ที่อยู่ IPv6 หรือ IPv6 CIDR ตั้งแต่ /48 ถึง /128 ระบบจะปฏิเสธช่วง IP ส่วนตัว, loopback และช่วงที่สงวนไว้ (422) มีผลที่เกตเวย์ภายใน 60 วินาที
การยืนยันตัวตน: ใช้คีย์ API ในส่วนหัว Authorization: Bearer API_KEY
เนื้อหาคำขอ
| ฟิลด์ | ประเภท | จำเป็น | คำอธิบาย |
|---|---|---|---|
cidr | string | ใช่ | — |
label | string | ไม่ | สูงสุด 60 ตัวอักษร |
{
"cidr": "203.0.113.24",
"label": "Office server"
}การตอบกลับ 201 Created
{
"id": "ipw_8c1k2m",
"cidr": "203.0.113.24",
"label": "Office server",
"createdAt": "2026-10-05T14:03:11Z"
}ตัวอย่างโค้ด
curl -s -X POST "https://localserpproxy.com/api/v1/ip-whitelist" \
-H "Authorization: Bearer $API_KEY" \
-H "Content-Type: application/json" \
-d '{"cidr":"203.0.113.24","label":"Office server"}'import os
import requests
API = "https://localserpproxy.com/api/v1"
HEADERS = {"Authorization": f"Bearer {os.environ['API_KEY']}"}
r = requests.post(f"{API}/ip-whitelist", headers=HEADERS, json={"cidr": "203.0.113.24", "label": "Office server"}, timeout=30)
r.raise_for_status()
print(r.json())// Node.js 18+ (built-in fetch), ES module
const API = 'https://localserpproxy.com/api/v1';
const res = await fetch(`${API}/ip-whitelist`, {
method: 'POST',
headers: { Authorization: `Bearer ${process.env.API_KEY}`, 'Content-Type': 'application/json' },
body: JSON.stringify({ cidr: '203.0.113.24', label: 'Office server' }),
});
if (!res.ok) throw new Error((await res.json()).error?.message ?? `HTTP ${res.status}`);
console.log(await res.json());นำรายการออกจากรายการที่อนุญาต
DELETE/v1/ip-whitelist/{entryId}
การยืนยันตัวตน: ใช้คีย์ API ในส่วนหัว Authorization: Bearer API_KEY
พารามิเตอร์
| ชื่อ | ใน | ประเภท | จำเป็น | คำอธิบาย |
|---|---|---|---|---|
entryId | path | string | ใช่ | — |
การตอบกลับ 204 No Content
ไม่มีเนื้อหาคำขอ: ใช้รหัสสถานะเป็นคำตอบ
ตัวอย่างโค้ด
curl -s -X DELETE "https://localserpproxy.com/api/v1/ip-whitelist/ipw_8c1k2m" \
-H "Authorization: Bearer $API_KEY"import os
import requests
API = "https://localserpproxy.com/api/v1"
HEADERS = {"Authorization": f"Bearer {os.environ['API_KEY']}"}
r = requests.delete(f"{API}/ip-whitelist/ipw_8c1k2m", headers=HEADERS, timeout=30)
r.raise_for_status()
print(r.status_code) # 204: done// Node.js 18+ (built-in fetch), ES module
const API = 'https://localserpproxy.com/api/v1';
const res = await fetch(`${API}/ip-whitelist/ipw_8c1k2m`, {
method: 'DELETE',
headers: { Authorization: `Bearer ${process.env.API_KEY}` },
});
if (!res.ok) throw new Error(`HTTP ${res.status}`);
console.log(res.status); // 204: done