Các điểm cuối trên trang này
GET /v1/api-keys: Liệt kê API keysPOST /v1/api-keys: Tạo API keyDELETE /v1/api-keys/{keyId}: Thu hồi API keyGET /v1/ip-whitelist: Liệt kê danh sách IP cho phépPOST /v1/ip-whitelist: Thêm IP hoặc dải IP vào danh sách cho phépDELETE /v1/ip-whitelist/{entryId}: Xóa mục khỏi danh sách cho phép
URL cơ sở https://localserpproxy.com/api/v1. Xem tổng quan API để biết thông tin xác thực, lỗi và giới hạn.
Liệt kê API keys
GET/v1/api-keys
Xác thực: khóa API trong tiêu đề Authorization: Bearer API_KEY.
Phản hồi 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
}Ví dụ mã
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());Tạo API key
POST/v1/api-keys
Toàn bộ secret sẽ được hoàn lại một lần.
Xác thực: khóa API trong tiêu đề Authorization: Bearer API_KEY.
Nội dung yêu cầu
| Trường | Kiểu | Bắt buộc | Mô tả |
|---|---|---|---|
name | string | Có | tối đa 60 ký tự |
scopes | array of read · proxies · billing | Có | — |
{
"name": "Rotation script",
"scopes": [
"read",
"proxies"
]
}Phản hồi 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"
}Ví dụ mã
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());Thu hồi API key
DELETE/v1/api-keys/{keyId}
Xác thực: khóa API trong tiêu đề Authorization: Bearer API_KEY.
Tham số
| Tên | Trong | Kiểu | Bắt buộc | Mô tả |
|---|---|---|---|---|
keyId | path | string | Có | — |
Phản hồi 204 No Content
Không có nội dung yêu cầu: mã trạng thái là câu trả lời.
Ví dụ mã
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: doneLiệt kê danh sách IP được cho phép
GET/v1/ip-whitelist
Xác thực: khóa API trong tiêu đề Authorization: Bearer API_KEY.
Phản hồi 200 OK
{
"data": [
{
"id": "ipw_8c1k2m",
"cidr": "203.0.113.24",
"label": "Office server",
"createdAt": "2026-10-05T14:03:11Z"
}
],
"limit": 10
}Ví dụ mã
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());Thêm IP hoặc dải IP vào danh sách được cho phép
POST/v1/ip-whitelist
Chấp nhận địa chỉ IPv4, CIDR IPv4 từ /24 đến /32, địa chỉ IPv6 hoặc CIDR IPv6 từ /48 đến /128. Từ chối các dải IP riêng tư, loopback và dành riêng (422). Có hiệu lực tại gateway trong vòng 60 s.
Xác thực: khóa API trong tiêu đề Authorization: Bearer API_KEY.
Nội dung yêu cầu
| Trường | Kiểu | Bắt buộc | Mô tả |
|---|---|---|---|
cidr | string | Có | — |
label | string | Không | tối đa 60 ký tự |
{
"cidr": "203.0.113.24",
"label": "Office server"
}Phản hồi 201 Created
{
"id": "ipw_8c1k2m",
"cidr": "203.0.113.24",
"label": "Office server",
"createdAt": "2026-10-05T14:03:11Z"
}Ví dụ mã
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());Xóa mục khỏi danh sách được cho phép
DELETE/v1/ip-whitelist/{entryId}
Xác thực: khóa API trong tiêu đề Authorization: Bearer API_KEY.
Tham số
| Tên | Trong | Kiểu | Bắt buộc | Mô tả |
|---|---|---|---|---|
entryId | path | string | Có | — |
Phản hồi 204 No Content
Không có nội dung yêu cầu: mã trạng thái là câu trả lời.
Ví dụ mã
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